{"id":176,"date":"2010-05-14T12:03:51","date_gmt":"2010-05-14T12:03:51","guid":{"rendered":"http:\/\/nicholshayes.myzen.co.uk\/blog\/?p=176"},"modified":"2010-05-27T15:37:44","modified_gmt":"2010-05-27T15:37:44","slug":"unit-testing-attachment_fu","status":"publish","type":"post","link":"http:\/\/nicholshayes.co.uk\/blog\/?p=176","title":{"rendered":"Unit testing attachment_fu"},"content":{"rendered":"

I’m working on a portion of my latest application that will need a facility to upload files. As these files are not images, I decided to use the plug-in attachment_fu<\/a>. The thing that has caused me the most head scratching was how to set up unit tests to work with attachment_fu.<\/p>\n

The class stores files related to a product. These are either code exerts or documentation. I’ve called the class ProductFile.<\/p>\n

Params<\/h3>\n

If you are going to run tests that pass in data via a params hash, how do you get a file into the params in the right format. Here is the solution I worked out:<\/p>\n

test_file_path = ActionController::TestCase<\/span>.fixture_path<\/span> +<\/span> '\/files\/test.txt'<\/span>
\ntest_file = ActionController::TestUploadedFile<\/span>.new<\/span>(<\/span>test_file_path)<\/span>
\n@product_file_params<\/span> = {<\/span>
\n  product_id =><\/span> 1<\/span>,
\n  :document_type<\/span> =><\/span> 'document'<\/span>,
\n  :version<\/span> =><\/span> 2<\/span>,
\n  :uploaded_data<\/span> =><\/span> test_file
\n}<\/span><\/div><\/div>\n

I couldn’t get this to work without having the test file in a sub-folder of the fixtures folder. So I added a file ‘test\/fixtures\/files\/test.txt’. Then I used ActionController::TestCase.fixture_path to determine the path.<\/p>\n

Tear down<\/h3>\n

The other problem I had was that the standard Rails unit test tear down process wasn’t removing files created during the test. I overcame this by keeping track of each ProductFile created during the tests, and then using a teardown method to remove them all at the end of the test. This is the code that achieved that:<\/p>\n

@@created_product_files = Array<\/span>.new<\/span>
\n
\ndef<\/span> create_product_file_from_params(<\/span>params_mod = {<\/span>}<\/span>)<\/span>
\n  product_file = ProductFile.create<\/span>(<\/span>@product_file_params.merge<\/span>(<\/span>params_mod)<\/span>)<\/span>
\n  @@created_product_files <<<\/span> product_file
\n  return<\/span> product_file
\nend<\/span>
\n
\ndef<\/span> teardown
\n  remove_product_files_created_during_test
\nend<\/span>
\n
\ndef<\/span> remove_product_files_created_during_test
\n  for<\/span> product_file in<\/span> @@created_product_files
\n    product_file.destroy<\/span> if<\/span> product_file.filename<\/span>
\n  end<\/span>
\nend<\/span><\/div><\/div>\n

Now, as long as I used the create_product_file_from_params to create new product_files with params, the test would clean up after itself.<\/p>\n

Fixtures<\/h3>\n

By the way, Product Files created via fixtures didn’t create a matching file in the file system. Which make it easier to keep things tidy, but needs to be kept in mind if you need an actual file to test against.<\/p>\n

References<\/h3>\n

attachment_fu wiki<\/a><\/p>\n

Mike Clark’s example of using attachment_fu<\/a><\/p>\n

David Jones’ very interesting article on using attachment_fu with acts_as_versioned<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

I’m working on a portion of my latest application that will need a facility to upload files. As these files are not images, I decided to use the plug-in attachment_fu. The thing that has caused me the most head scratching … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[3],"tags":[],"_links":{"self":[{"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/posts\/176"}],"collection":[{"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=176"}],"version-history":[{"count":24,"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/posts\/176\/revisions"}],"predecessor-version":[{"id":197,"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=\/wp\/v2\/posts\/176\/revisions\/197"}],"wp:attachment":[{"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=176"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=176"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/nicholshayes.co.uk\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=176"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}