How do I keep a controller spec and its mocks DRY? - ruby-on-rails

I'm told this is the correct way to write a controller it block:
describe UsersController do
let(:user){ mock_model(User, id: 2, name: "Jimbo", email: 'jimbo#email.com', password: 'passwordhuzzah', password_confirmation: 'passwordhuzzah') }
describe 'PATCH #update' do
it "should fail in this case" do
User.should_receive(:find).with(user.id.to_s).and_return user
user.should_receive(:update_attributes).with({ "email" => user.email, "name" => user.name, "password" => user.password, "password_confirmation" => user.password_confirmation }).and_return true
patch :update, id: user.id, user: { email: user.email, name: user.name, password: user.password, password_confirmation: user.password_confirmation }
flash[:error].should == "could not update user"
response.status.should == 200
end
end
end
But I am surprised, because it doesn't seem DRY to me. Let's say I want to create two 'contexts' here. One where the user.update_attributes call returns false and returns true. Am I meant to simply copy paste two it blocks and tweak that one tiny argument?
describe UsersController do
let(:user){ mock_model(User, id: 2, name: "Jimbo", email: 'jimbo#email.com', password: 'passwordhuzzah', password_confirmation: 'passwordhuzzah') }
it "should pass in this case" do
User.should_receive(:find).with(user.id.to_s).and_return user
user.should_receive(:update_attributes).with({ "email" => user.email, "name" => user.name, "password" => user.password, "password_confirmation" => user.password_confirmation }).and_return true
patch :update, id: user.id, user: { email: user.email, name: user.name, password: user.password, password_confirmation: user.password_confirmation }
flash[:error].should == "updated user"
response.status.should == 302
end
it "should fail in this case" do
User.should_receive(:find).with(user.id.to_s).and_return user
user.should_receive(:update_attributes).with({ "email" => user.email, "name" => user.name, "password" => user.password, "password_confirmation" => user.password_confirmation }).and_return false
patch :update, id: user.id, user: { email: user.email, name: user.name, password: user.password, password_confirmation: user.password_confirmation }
flash[:error].should == "could not update user"
response.status.should == 200
end
end
end
I was hoping rspec would allow me to write this sort of structure:
describe 'PATCH #update' do
before {}
context 'when attributes can be updated' do
before {}
it "should set the flash" do end
it "should set the status" do end
end
context 'when attributes can\'t be updated' do
before {}
it "should set the status" do end
it "should set the flash" do end
end
end
Note the multiple it blocks for the same contexts, because isn't one expectation per it block a good practise because it allows you to see exactly what's not working? How are you meant to do this with mocks?

Related

RSpec Unit Testing controller method

am relatively new with rspec and testing,am trying to write a test for this code
#assessments = Assessment.where(assigned_user_id: current_user.id)
here is what i have tried so far,but am not sure if it's the right way,i was told controller spec is not advisable,hence i am trying to implement it using unit test.
spec_file
require 'rails_helper'
# Test suite for the assessment model
RSpec.describe Assessment, type: :model do
let(:admin) { User.new(email: 'rockcoolsaint#example.com', password: 'password', password_confirmation: 'password', role: :admin) }
let(:behavioral_specialist) { User.new(email: 'bs#example.com', password: 'password', password_confirmation: 'password', role: :behavioral_specialist) }
let(:behavioral_specialist_2) { User.new(email: 'bs2#example.com', password: 'password', password_confirmation: 'password', role: :behavioral_specialist) }
let(:bs_user_assessments) { Assessment.where(assigned_user_id: behavioral_specialist.id) }
describe 'Validations' do
it { should validate_presence_of(:title) }
it 'is valid with all attributes' do
expect(build(:assessment, user: admin, assigned_user: behavioral_specialist)).to be_valid
end
it 'is valid if assigned_user_id equals behavioral_specialist_id' do
bs_user_assessments.each do |assessment|
expect(assessment.assigned_user_id).to eq(behavioral_specialist.id)
end
end
it 'is valid if assigned_user_id does not equal behavioral_specialist_2_id' do
bs_user_assessments.each do |assessment|
expect(assessment.assigned_user_id).to_not eq(behavioral_specialist_2.id)
end
end
end

Google Omniauth2 Rails Giving me "Example User" when testing

I am attempting to stub out an omniauth authentication hash to test my integration with RSpec. For some reason my User model is being fed an "Example User," that does not have all the info a regular signed in Google user would have.
This is the param given to User that is breaking the tests: {"provider"=>"default", "uid"=>"1234", "info"=>{"name"=>"Example User"}}
This is what it should be, and if I step to the next iteration with pry, it works:
{:provider=>"google",
:uid=>"12345678910",
:info=>{:email=>"limsammy1#gmail.com", :first_name=>"Sam", :last_name=>"Lim"},
:credentials=>{:token=>"abcdefg12345", :refresh_token=>"12345abcdefg", :expires_at=>Thu, 16 Nov 2017 15:27:23 -0700}}
Here is my spec:
require 'rails_helper'
def stub_omniauth
OmniAuth.config.test_mode = true
OmniAuth.config.mock_auth[:google] = OmniAuth::AuthHash.new({
provider: "google_oauth2",
uid: "12345678910",
info: {
email: "limsammy1#gmail.com",
first_name: "Sam",
last_name: "Lim"
},
credentials: {
token: "abcdefg12345",
refresh_token: "abcdefg12345",
expires_at: DateTime.now,
}
})
end
RSpec.feature "user logs in" do
scenario "using google oauth2 'omniauth'" do
stub_omniauth
visit root_path
expect(page).to have_link("Sign in with Google")
click_link "Sign in with Google"
expect(page).to have_content("Sam Lim")
expect(page).to have_content("Logout")
end
end
And here is my User model method:
def self.update_or_create(auth)
user = User.find_by(uid: auth[:uid]) || User.new
binding.pry
user.attributes = {
provider: auth[:provider],
uid: auth[:uid],
email: auth[:info][:email],
first_name: auth[:info][:first_name],
last_name: auth[:info][:last_name],
token: auth[:credentials][:token],
refresh_token: auth[:credentials][:refresh_token],
oauth_expires_at: auth[:credentials][:expires_at]
}
user.save!
user
end
I call that method in my sessions controller here:
def create
user = User.update_or_create(request.env["omniauth.auth"])
session[:id] = user.id
redirect_to root_path
end
I came across exactly this issue some days ago.
The problem is in def stub_omniauth.
You should change OmniAuth.config.mock_auth[:google] => OmniAuth.config.mock_auth[:google_oauth2]

Ruby on Rails, Michael Hartl;s Tutorial chapter 6.31

I got two tests that are failing in my application. I see that the problem is with the user's ID but I don't know how to solve it.
1) User return value of authenticate method with valid password
Failure/Error: it { should eq found_user.authenticate(#user.password) }
expected: #<User id: 2, name: "Example User", email: "user#example.com", created_at: "2014-08-09 17:17:22", updated_at: "2014-08-09 17:17:22", password_digest: "$2a$04$kQk6PkLu3X6rbTPiDDPce.zy6VYtAZ2rxchGLSP27VaG...">
got: #<User id: nil, name: "Example User", email: "user#example.com", created_at: nil, updated_at: nil, password_digest: "$2a$04$dccvbYxyrCa2M1LjxmwQqOBEEhYLNKrFmUh0GlAxH1bH...">
(compared using ==)
Diff:
## -1,2 +1,2 ##
-#<User id: 2, name: "Example User", email: "user#example.com", created_at: "2014-08-09 17:17:22", updated_at: "2014-08-09 17:17:22", password_digest: "$2a$04$kQk6PkLu3X6rbTPiDDPce.zy6VYtAZ2rxchGLSP27VaG...">
+#<User id: nil, name: "Example User", email: "user#example.com", created_at: nil, updated_at: nil, password_digest: "$2a$04$dccvbYxyrCa2M1LjxmwQqOBEEhYLNKrFmUh0GlAxH1bH...">
# ./spec/models/user_spec.rb:102:in `block (4 levels) in <top (required)>'
2) User email address with mixed case should be saved as all lower-case
Failure/Error: expect(#user.reload.email).to eq mixed_case_email.downcase
ActiveRecord::RecordNotFound:
Couldn't find User without an ID
# ./spec/models/user_spec.rb:72:in `block (3 levels) in <top (required)>'
Here is my user_spec.rb file :
describe User do
before do
#user = User.new(name: "Example User", email: "user#example.com",
password: "foobar", password_confirmation: "foobar")
end
subject {#user}
it {should respond_to(:name)}
it {should respond_to(:email)}
it {should respond_to(:password_digest)}
it {should respond_to(:password)}
it {should respond_to(:password_confirmation)}
it {should respond_to(:authenticate)}
describe "When name is not present" do
before {#user.name = " "}
it {should_not be_valid}
end
describe "When email is not present" do
before {#user.email = " "}
it {should_not be_valid}
end
describe "When name is too long" do
before {#user.name = "a"*51}
it {should_not be_valid}
end
describe "when email format is invalid" do
it "should be invalid" do
addresses = %w[user#foo,com user_at_foo.org example.user#foo.
foo#bar_baz.com foo#bar+baz.com]
addresses.each do |invalid_address|
#user.email = invalid_address
expect(#user).not_to be_valid
end
end
end
describe "when email format is valid" do
it "should be valid" do
addresses = %w[user#foo.COM A_US-ER#f.b.org frst.lst#foo.jp a+b#baz.cn]
addresses.each do |valid_address|
#user.email = valid_address
expect(#user).to be_valid
end
end
end
describe "when email address is already taken" do
before do
user_with_same_email = #user.dup
user_with_same_email.email = #user.email.upcase
user_with_same_email.save
end
it { should_not be_valid }
end
describe "email address with mixed case" do
let(:mixed_case_email) { "Foo#ExAMPle.CoM" }
it "should be saved as all lower-case" do
#user.email = mixed_case_email
#user.save
expect(#user.reload.email).to eq mixed_case_email.downcase
end
end
#PASSWORD
describe "when password is not present" do
before do
#user = User.new(name: "Example User", email: "user#example.com",
password: " ", password_confirmation: " ")
it { should_not be_valid }
end
end
describe "when password doesn't match confirmation" do
before { #user.password_confirmation = "mismatch" }
it { should_not be_valid }
end
describe "with a password that's too short" do
before { #user.password = #user.password_confirmation = "a" * 5 }
it { should be_invalid }
end
describe "return value of authenticate method" do
before { #user.save }
let(:found_user) { User.find_by(email: #user.email) }
describe "with valid password" do
it { should eq found_user.authenticate(#user.password) }
end
describe "with invalid password" do
let(:user_for_invalid_password) { found_user.authenticate("invalid") }
it { should_not eq user_for_invalid_password }
specify { expect(user_for_invalid_password).to be_false }
end
end
end
And the user.rb file
class User < ActiveRecord::Base
before_save { self.email = email.downcase }
validates :name, presence: true, length: { maximum: 50 }
VALID_EMAIL_REGEX = /\A[\w+\-.]+#[a-z\d\-]+(?:\.[a-z\d\-]+)*\.[a-z]+\z/i
validates :email, presence: true, format: { with: VALID_EMAIL_REGEX },
uniqueness: { case_sensitive: false }
has_secure_password
validates :password, length: { minimum: 6 }
end
Change
#user = User.new(name: "Example User", email: "user#example.com",
password: "foobar", password_confirmation: "foobar")
to
#user = User.create(name: "Example User", email: "user#example.com",
password: "foobar", password_confirmation: "foobar")
new just creates a model but doesnt save it to DB whereas
create creates the model AND saves it to DB
other option is to use save
#user = User.new(name: "Example User", email: "user#example.com",
password: "foobar", password_confirmation: "foobar")
#user.save
(For the 2ยบ test) You have to save the user in a before block
describe "email address with mixed case" do
let(:mixed_case_email) { "Foo#ExAMPle.CoM" }
before do
#user.email = mixed_case_email
#user.save
end
it "should be saved as all lower-case" do
expect(#user.reload.email).to eq mixed_case_email.downcase
end
end
That is the problem which causes "Couldn't find User without an ID"
The error is here:
specify { expect(user_for_invalid_password).to be_false }
this line is wrong, correct one is:
specify { expect(user_for_invalid_password).to be false }

Using a hash inside a let()

I'm trying to DRY my code by putting a hash into a let and just calling the let but it doesn't seem to work. I get these errors:
syntax error, unexpected =>, expecting '}' (SyntaxError) "email" => user.email,
syntax error, unexpected =>, expecting :: or '[' or '.' ...l" => user.email, "password" => user.password }
Here's my test:
describe '#create' do
let(:user) { create(:user) }
let(:user_params) { "email" => user.email, "password" => user.password }
before(:each) { User.stub(:find_by_email).and_return(user) }
it "should send find message to user model" do
User.should_receive(:find_by_email)
post :create, locale: "es", user: { user_params }
end
it "should set user to #user" do
post :create, locale: "es", user: { "email" => user.email, "password" => user.password }
assigns(:user).should eq(user)
end
end
And here's my code:
def create
#user = User.find_by_email(params[:email])
if #user && #user.authenticate(params[:password])
session[:user_id] = #user.id
redirect_to root_url
else
render 'login'
end
end
You're missing one pair of braces.
let(:user_params) { "email" => user.email, "password" => user.password }
should be
let(:user_params) { {"email" => user.email, "password" => user.password} }
I would prefer a bit longer explanation.
When you write something like this:
let(:user_params) { "email" => user.email, "password" => user.password }
You call method let with one parameter (:user_params) and a block (in this case { "email" => user.email, "password" => user.password }). I will state it again:
let(:something) { some_method_call }
and
let(:something) do
some_method_call
end
are equal. By using let, RSpec sets variable to the result of the block. So, inside of the block, you need to return something. In this case - hash:
let(:user_params) do
{ "email" => user.email, "password" => user.password }
end
That's it! You can find out more about let on APIdock

Failing Rspec Test with MongoID , Custom Authentication, Password Digest

i have completed the rails tutorial http://ruby.railstutorial.org/, and trying to implement the user model, but in MongoDB, using MongoID.
I have the following code, which is almost exactly the same as the tutorial, yet it's failing on one of the test cases.
class User
include Mongoid::Document
include ActiveModel::SecurePassword
attr_accessible :name, :email, :password, :password_confirmation
field :name, type: String
field :email, type: String
field :password_digest, type: String
has_secure_password
before_save { |user| user.email = email.downcase }
email_regex = /\A[\w+\-.]+#[a-z\d\-.]+\.[a-z]+\z/i
validates :name, presence: true, length: { maximum: 50}
validates :email, presence: true, format: { with: email_regex },
uniqueness: { case_sensitive: false }
validates :password, presence: true, length: { minimum: 5}
validates :password_confirmation, presence: true
end
and rspec tests:
require 'spec_helper'
describe User do
before do
#user = User.new(name: "Example User", email: "user#example.com",
password: "foobar", password_confirmation: "foobar")
end
subject { #user }
it { should respond_to(:name) }
it { should respond_to(:email) }
it { should respond_to(:password_digest) }
it { should respond_to(:password) }
it { should respond_to(:password_confirmation) }
it { should respond_to(:authenticate) }
describe 'without a name' do
before { #user.name = "" }
it { should_not be_valid }
end
describe 'without an email' do
before { #user.email = "" }
it { should_not be_valid }
end
describe "when name is too long" do
before { #user.name = "a" * 51 }
it { should_not be_valid }
end
describe "when email format is invalid" do
it "should be invalid" do
addresses = %w[user#foo,com user_at_foo.org example.user#foo.
foo#bar_baz.com foo#bar+baz.com]
addresses.each do |invalid_address|
#user.email = invalid_address
#user.should_not be_valid
end
end
end
describe "when email format is valid" do
it "should be valid" do
addresses = %w[user#foo.COM A_US-ER#f.b.org frst.lst#foo.jp a+b#baz.cn]
addresses.each do |valid_address|
#user.email = valid_address
#user.should be_valid
end
end
end
describe "when email address is already taken" do
before do
user_with_same_email = #user.dup
user_with_same_email.email = #user.email.upcase
user_with_same_email.save
end
it { should_not be_valid }
end
describe "when password is not present" do
before { #user.password = #user.password_confirmation = " " }
it { should_not be_valid }
end
describe "when password doesn't match confirmation" do
before { #user.password_confirmation = "mismatch" }
it { should_not be_valid }
end
describe "when password confirmation is nil" do
before { #user.password_confirmation = nil }
it { should_not be_valid }
end
describe "with a password that's too short" do
before { #user.password = #user.password_confirmation = "a" * 5 }
it { should be_invalid }
end
describe "return value of authenticate method" do
before { #user.save }
let(:found_user) { User.find_by(email: #user.email) }
describe "with valid password" do
it { should == found_user.authenticate(#user.password) }
end
describe "with invalid password" do
let(:user_for_invalid_password) { found_user.authenticate("invalid") }
it { should_not == user_for_invalid_password }
specify { user_for_invalid_password.should be_false }
end
end
end
The failure on the spec is:
........F..........
Failures:
1) User return value of authenticate method with valid password
Failure/Error: it { should == found_user.authenticate(#user.password) }
expected: #<User _id: 50e30a678bffa61a9e000001, _type: nil, name: "Example User", email: "user#example.com", password_digest: "$2a$10$C6klW7B9ok4OIHFopy5AfuncvwNYTZqHWTbqpdd8gXmruSLlwizPO">
got: #<User _id: 50e30f158bffa6df67000001, _type: nil, name: "Example User", email: "user#example.com", password_digest: "$2a$10$mDCz9JVPXGSvpGBwbyHIsuV/k.lJ/ux1TuvgRzxSLYlIna/CdztN2"> (using ==)
Diff:
## -1,2 +1,2 ##
-#<User _id: 50e30a678bffa61a9e000001, _type: nil, name: "Example User", email: "user#example.com", password_digest: "$2a$10$C6klW7B9ok4OIHFopy5AfuncvwNYTZqHWTbqpdd8gXmruSLlwizPO">
+#<User _id: 50e30f158bffa6df67000001, _type: nil, name: "Example User", email: "user#example.com", password_digest: "$2a$10$mDCz9JVPXGSvpGBwbyHIsuV/k.lJ/ux1TuvgRzxSLYlIna/CdztN2">
# ./spec/models/user_spec.rb:89:in `block (4 levels) in <top (required)>'
Finished in 1.79 seconds
19 examples, 1 failure
Update:
Did a bit more diggig, and querying the test database it seems that the data is not being cleared before each test case.
Updat2:
I have managed to fix this by including the following in my Spec Helper:
config.before :each do
Mongoid.purge!
end
But tests are noticeably slower now! any idea how to speed it up?
The problem is calling save, which recreates the password_digest
describe "return value of authenticate method" do
#before { #user.save } #comment this line
#....
end

Resources