Rss Feed Tweeter button Facebook button Technorati button Reddit button Linkedin button Webonews button Delicious button Digg button Flickr button Stumbleupon button Newsvine button

A Waage Blog

Ruby, Rails, Life

Archive for the ‘Rails Testing’ Category

Functional Testing Cookies in Ruby on Rails 1.2.3

with 2 comments

After spending a good couple hours + trying to figure out why my functional tests were failing when working with cookies, I came across a couple great resources for rails + testing cookies.

Here’s a good basic explanation of using cookies on Pluit solutions website. Then I came across the Robby on Rails blog that led me to understand (and misunderstand) the asssert_cookie plugin.

However, I was still having a lot of trouble figuring out why I was setting my @request.cookies['foo'] in my functional test, but later (in the same test method) checking for cookies['foo'] and not finding anything in the cookie jar!

I then tried setting cookies['foo'] in my controller test, but found that when I did a check for the existance of that cookie in my actual controller code, it was not there! I thought that I should be able to set up a cookie in a test and have my controller recognize it. This is true, however, not by setting cookies['foo'].

So… I opened up a blank controller and functional test and began testing out different combinations to find out exactly what was going on. I hope this little example helps to save someone else’s precious time. Here it goes…

This is the controller I will be referring to for my example tests:

========= controller
  def foo
    if cookies['oreo'] == 'yesitis'
      @info =  "Oreos are tasty"
    else
      @info = "Only Milk here"
    end
     render :nothing => true
  end

1. In your functional test, do not test for presence of a cookie after a get request to a particular action, unless the action you are testing specifically sets up that cookie. In other words, if your controller action is not setting the cookie, do not test for that cookie’s presence.

In the above controller, no cookies are ever being set. Therefore, testing for the presence of a cookie after the get request (in a test method) will return false.

In other words, the cookie is recognized by the controller, however, notice that cookies['oreo'] is nil after the get request:

  def test_oreo
    @request.cookies['oreo'] = CGI::Cookie.new("oreo", "yesitis")
    get :foo
    assert_equal({}, @response.cookies)
    assert_equal(nil, cookies['oreo'])
    #Assert cookie will be nil here so do not test it:
    #assert_cookie :o reo
    puts assigns['info'] #"Oreos are tasty"
  end

Note:
1. After your get request, the @response.cookies will be empty
2. After your get request, cookies['oreo'] will still be nil.
3. After your get request, you cannot use assert_cookie because it will be nil

2. If your controller action expects a cookie to be there, you cannot set it up in your functional test by assigning:

  • cookies['oreo'] = true (incorrect) OR
  • @request.cookies['oreo'] = true (incorrect)
  • The only way to set up your cookie for a subsequent request, so that your controller will see it is:

    • @request.cookies['oreo'] = CGI::Cookies.new(’oreo’, true) (correct)
      #INCORRECT
      def test_oreo
        cookies['oreo'] = 'yesitis'
        get :foo
        puts assigns['info'] #"Only Milk here"
      end
    
    #INCORRECT
      def test_oreo
        cookies['oreo'] =  CGI::Cookie.new("oreo", "yesitis")
        get :foo
        puts assigns['info'] #"Only Milk here"
      end
    
    #INCORRECT
      def test_oreo
        @request.cookies['oreo'] = 'yesitis'
        get :foo
        puts assigns['info'] #"Only Milk here"
      end

    The only way to set up your cookie in a functional test and have your controller recognize it.

    #CORRECT
      def test_oreo
        @request.cookies['oreo'] = CGI::Cookie.new("oreo", "yesitis")
        get :foo
        puts assigns['info'] # Will print out "Oreos are tasty"
      end

    3. Avoid the temptation to use symbols in your tests with cookies.

    • cookies[:foo] -> BAD
    • cookies['foo'] -> GOOD

    4. Only use assert_cookie (plugin: see above for link) if you are testing that the controller action is creating a new cookie.

    5. If you are testing multiple actions and redirects from one action to another action in the same controller, you do not need to set the cookie before each action, explicitly. The cookie will remain in the @request object that you created in the setup method of your test.

    EXAMPLE TWO (Testing persistent cookies)
    You DONT set up the cookie for each subsequent request.
    It does “persist” throughout your test-method because you are
    using the same @request object!!

    ========controller
      def foo
        if cookies['oreo'] == 'yesitis'
    	puts "Foo has OREO"
        else
     	puts "Foo has NOTHING"
        end
          redirect_to :action => :bar
          return true
      end
    
      def bar
        if cookies['oreo'] == 'yesitis'
          puts "Oreos are tasty"
        else
          puts "Only Milk here"
        end
         render :nothing => true
      end
    
    ========= Test
      def test_oreo
       @request.cookies['oreo'] =  CGI::Cookie.new('oreo', "yesitis")
        get :foo    #OUTPUTS: Foo has OREO
    
        # COOKIE PERSISTS HERE!!
        # Don't need to explicitly set cookie again in the
        # @request.cookies object
        get :bar   #OUTPUTS: Oreos are tasty
      end

    Written by Andrew Waage

    October 13th, 2008 at 7:33 am