如何以rspec方式改进此RSpec代码？

Question

我是Ruby和RSpec的新手.我来自Java背景,这就是为什么我的测试真的看起来像junit代码.我想更多地了解RSpec的,但我不太明白subject,let,!let.所以,如果有人可以指导我清理这些代码,我将非常感激.

我有Sinatra,RSpec正在用Twitter登录.

get '/login/twitter' do
  begin
    request_token = TwitterService.new.authentication_request_token

    session[:request_token_twitter] = request_token

    redirect request_token.authorize_url
  rescue Exception => e
    logger.error(e.message)
    redirect '/'
  end  
end

get '/login/twitter/success' do
  request_token = session[:request_token_twitter]
  twitter_service = TwitterService.new
  access_token = twitter_service.authorize(request_token, params[:oauth_verifier])

  begin
    twitter_user_info = twitter_service.verify_credentials

    twitter_id = twitter_user_info["id"]
    response.set_cookie("auth_token", :value => twitter_id, :path => '/')
    response.set_cookie(@social_flag, :value => "t", :path => '/')

    expected_user = @user_manager.find_by_id(twitter_id.to_s)

    if expected_user.is_null?
      twitter_user = User.new(twitter_id, access_token.token, access_token.secret, "t")
      twitter_user.save

      logger.info("Saving ...")
      logger.info("Twitter ID #{twitter_id}")

      redirect '/signup'
    else
      expected_user.token = access_token.token
      expected_user.secret = access_token.secret
      expected_user.update 

      logger.info("Updating token and secret ...")
      logger.info("Twitter ID #{twitter_id}")
    end

  rescue Exception => e
    logger.error(e.message)
    logger.error("There's something wrong with Twitter and user cannot log in")
    redirect '/'
  end

  redirect '/t'
end

这是我的RSpec.我知道这真的很难看.

describe "Twitter route" do
    include TwitterOAuth

    def app
        Sinatra::Application
    end

    context "/login/twitter" do
        it "should redirect to twitter authorized url" do
            request_token = OpenStruct.new
            request_token.authorize_url = "http://api.twitter.com/oauth/authenticate?oauth_token"

            TwitterService.any_instance.stub(:authentication_request_token).and_return(request_token)

            get '/login/twitter'
            last_response.header["Location"].should include "http://api.twitter.com/oauth/authenticate?oauth_token"
            last_response.status.should eql 302
            session[:request_token_twitter].authorize_url.should == "http://api.twitter.com/oauth/authenticate?oauth_token"
        end

        it "should redirect back to home page if error occurs" do
            TwitterService.any_instance.stub(:authentication_request_token).and_raise("Unauthorized")

            get '/login/twitter'

            last_response.header["Location"].should include "http://example.org/"
            last_response.status.should eql 302
            session[:request_token_twitter].should eql nil
        end

        it "should save a user after a success callback from twitter" do
            user_manager = UserManager.new

            access_token = OpenStruct.new
            access_token.token = "token"
            access_token.secret = "secret"

            TwitterService.any_instance.stub(:authorize).with(anything(), anything()).and_return(access_token)
            TwitterService.any_instance.stub(:verify_credentials).and_return({"id" => "id1"})

            get '/login/twitter/success'

            last_response.header["Location"].should include "/signup"
            rack_mock_session.cookie_jar["auth_token"].should eql "id1"
            rack_mock_session.cookie_jar["s_flag"].should eql "t"
            last_response.status.should eql 302

            user_manager = UserManager.new
            expected_user = user_manager.find_by_id("id1")
            expected_user.id.should eql "id1"
            expected_user.token.should eql "token"
            expected_user.secret.should eql "secret"
        end

        it "should update user token and secret if the user already exists" do
            User.new("id1", "token", "secret", "t").save

            access_token = OpenStruct.new
            access_token.token = "token1"
            access_token.secret = "secret1"

            TwitterService.any_instance.stub(:authorize).with(anything(), anything()).and_return(access_token)
            TwitterService.any_instance.stub(:verify_credentials).and_return({"id" => "id1"})

            get '/login/twitter/success'

            last_response.header["Location"].should include "/t"
            rack_mock_session.cookie_jar["auth_token"].should eql "id1"
            rack_mock_session.cookie_jar["s_flag"].should eql "t"
            last_response.status.should eql 302

            user_manager = UserManager.new
            expected_user = user_manager.find_by_id("id1")
            expected_user.id.should eql "id1"
            expected_user.token.should eql "token1"
            expected_user.secret.should eql "secret1"
        end

        it "should redirect back to the home page" do
            access_token = OpenStruct.new
            access_token.token = "token1"
            access_token.secret = "secret1"

            TwitterService.any_instance.stub(:authorize).with(anything(), anything()).and_return(access_token)
            TwitterService.any_instance.stub(:verify_credentials).and_raise

            get '/login/twitter/success'

            last_response.header["Location"].should include "http://example.org/"
            end

        end
end

任何改进我不仅要感谢代码.可能是因为我错过了一些明显的东西

非常感谢你们.

Answer 1

好的,这里发生了很多事!

首先,你应该尝试坚持每个例子一个测试.你的例子目前正在测试一大堆行为,这意味着你的测试是全有或全无的,并且可能会让你不清楚如果你破坏了什么会特别破坏.

首先,我要添加一个新的匹配器.你通常把它放在spec/support/matchers.rb之类的东西上.它只是扩展rspec,以便我们可以测试响应是重定向,并且重定向到达给定位置:

RSpec::Matchers.define :redirect_to do |expected|
  match do |actual|
    actual.should be_redirect
    actual.location.should include expected
  end
end

现在,进入代码!

未注释的来源在这里:https://gist.github.com/cheald/5908093 - 这可能不那么烦人了:)

let定义一个每个示例只运行一次的方法,无论它被调用多少次.这让我们有一个在example-time定义的"变量",它允许我们在嵌套的例子中覆盖它.在这里,我已经access_token定义了top,但是我们将let在更深层次的示例中进行另一次access_token.这个套件并没有真正展示这一点,但这可以让你做一些好东西,其中一个东西let在另一个东西中被引用.想象一下,如果你愿意的话,那就是我们拥有的

let(:user) { user_manager.find(access_token.id) }

这将使用最深层嵌套的user_manager和deeppest-nested access_token,而无需在每个嵌套范围内重新声明用户.便利!

let在使用块之前不会调用块(与let!块相反,块在声明时始终被调用)

describe "Twitter route" do
  include TwitterOAuth

  let(:app) {  Sinatra::Application }
  let(:request_token) { double("request_token", authorize_url: "http://api.twitter.com/oauth/authenticate?oauth_token") }
  let(:access_token) { double("token", token: "token", secret: "secret") }
  let(:user_manager) { UserManager.new }

你会注意到我已经将你的测试分解为嵌套的上下文,将类似的行为分组.也就是说,应该使用授权令牌传递的所有测试都嵌套在授权令牌上下文中,并且我们的before块会设置上下文,以便此上下文中的所有示例都获得有效令牌.

我们也继续前进,get然后我们可以直接测试结果.

  context "/login/twitter" do
    context "with an authorized token" do
      before do
        TwitterService.any_instance.stub(:authentication_request_token).and_return(request_token)
        TwitterService.any_instance.stub(:authorize).with(anything(), anything()).and_return(access_token)
        TwitterService.any_instance.stub(:verify_credentials).and_return({"id" => "id1"})
        get '/login/twitter'
      end

你在这里看到我正在使用我们的新匹配器.它允许我们在一次测试中检查重定向到给定的URL.

      it "should redirect to twitter authorized url" do
        last_response.should redirect_to "http://api.twitter.com/oauth/authenticate?oauth_token"
      end

      it "should set a the request token in the session" do
        session[:request_token_twitter].authorize_url.should == "http://api.twitter.com/oauth/authenticate?oauth_token"
      end

      context "after a success callback" do
        let(:user) { user_manager.find_by_id("id1") }
        context "when there is not an existing user" do
          before do
            get '/login/twitter/success'
          end

          it "should redirect to /signup" do
            last_response.should redirect_to "/signup"
          end

          it "should set an auth_token cookie" do
            rack_mock_session.cookie_jar["auth_token"].should == "id1"
          end

          it "should set an s_flag cookie" do
            rack_mock_session.cookie_jar["s_flag"].should == "t"
          end

在这里你会看到subject.它只定义变量subject返回的内容,并使its块对其进行操作.在这种情况下,主题是User记录.由于subject是用户记录,我可以使用更简洁的表单来检查其属性.

          context "the authenticated user" do
            subject { user }
            its(:id)     { should == "id1" }
            its(:token)  { should == "token" }
            its(:secret) { should == "secret" }
          end
        end

你会在这里看到我提供了一个新的定义access_token.当这些示例运行时,顶部的前块(设置"授权令牌")将使用此access_token而不是那里定义的方式.这使我们可以使用特定于此特定上下文的变量覆盖用于设置上下文的变量.

        context "when there is an existing user" do
          let(:access_token) { double("token", token: "newtoken", secret: "newsecret") }
          before do
            User.new("id1", "oldtoken", "oldsecret", "t").save
            get '/login/twitter/success'
          end

          it "should set an auth_token cookie" do
            rack_mock_session.cookie_jar["auth_token"].should == "id1"
          end

          it "should set an s_flag cookie" do
            rack_mock_session.cookie_jar["s_flag"].should == "t"
          end

          it "should redirect to /t" do
            last_response.should redirect_to "/t"
          end

          context "the authenticated user" do
            subject { user }
            its(:id)     { should == "id1" }
            its(:token)  { should == "newtoken" }
            its(:secret) { should == "newsecret" }
          end
        end
      end
    end

    context "with an invalid token" do
      before do
        TwitterService.any_instance.stub(:authentication_request_token).and_raise("Unauthorized")
        get '/login/twitter'
      end

      it "should redirect back to home page if error occurs" do
        last_response.should redirect_to "http://example.org/"
      end

      it "should not set a session value" do
        session[:request_token_twitter].should be_nil
      end
    end
  end
end