Add basic model and controller tests for current application functionality

Robert Clark · Robert Clark · commit ffbc2c841b90 · 2020-05-28T12:22:22.000-04:00
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -11,3 +11,9 @@ AllCops:
     - 'vendor/**/*'
 Layout/LineLength:
   Max: 120
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
diff --git a/Gemfile b/Gemfile
@@ -53,6 +53,7 @@ group :development do
   gem 'listen', '>= 3.0.5', '< 3.2'
   gem 'web-console', '>= 3.3.0'
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'letter_opener'
   gem 'spring'
   gem 'spring-watcher-listen', '~> 2.0.0'
 end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -123,6 +123,10 @@ GEM
     jbuilder (2.10.0)
       activesupport (>= 5.0.0)
     jwt (2.2.1)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    letter_opener (1.7.0)
+      launchy (~> 2.2)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -319,6 +323,7 @@ DEPENDENCIES
   gitlab_omniauth-ldap (~> 2.1.1)
   haml-rails (~> 2.0)
   jbuilder (~> 2.7)
+  letter_opener
   listen (>= 3.0.5, < 3.2)
   omniauth (~> 1.8)
   omniauth-github
diff --git a/Procfile.dev b/Procfile.dev
@@ -1,2 +1,2 @@
-web: bundle exec rails s
+web: bundle exec rails s -p 3000
 webpacker: ./bin/webpack-dev-server
diff --git a/app/controllers/users/registrations_controller.rb b/app/controllers/users/registrations_controller.rb
@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-class Users
+module Users
   # This controller exists so that we can block user registration if local user
   # login is disabled.
   class RegistrationsController < Devise::RegistrationsController
     def create
       if Settings.local_login.enabled
         super
       else
-        redirect :back, alert: 'New user registration is not currently enabled.'
+        redirect_back(fallback_location: new_user_session_path, alert: I18n.t('devise.registrations.disabled'))
       end
     end
   end
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-# This allows us access to the _path variables inside the application
-include Rails.application.routes.url_helpers
-
 # This module handles items that we use across multiple controllers
 # and views throughout the application
 module ApplicationHelper
+  # This allows us access to the _path variables inside the application
+  include Rails.application.routes.url_helpers
+
   # Build the links shown to users in the navigation bar
   def base_navigation
     [
diff --git a/app/views/devise/sessions/new.html.haml b/app/views/devise/sessions/new.html.haml
@@ -17,7 +17,7 @@
               %b-card-text
                 = render 'devise/sessions/ldap'
           - if Settings.local_login.enabled
-            %b-tab{:active => params[:active_tab].eql?('local') ? true : false, :title => "Login"}
+            %b-tab{:active => params[:active_tab].eql?('local') ? true : false, :title => "Local Login"}
               %b-card-text
                 = render 'devise/sessions/local'
             %b-tab{:active => params[:active_tab].eql?('registration') ? true : false, :title => "Register"}
diff --git a/config/environments/development.rb b/config/environments/development.rb
@@ -50,6 +50,12 @@
   # Raises error for missing translations.
   # config.action_view.raise_on_missing_translations = true
 
+  # Use the letter opener gem for email delivery in development
+  config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.perform_deliveries = true
+
+  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
   config.file_watcher = ActiveSupport::EventedFileUpdateChecker
diff --git a/config/environments/test.rb b/config/environments/test.rb
@@ -42,6 +42,8 @@
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
 
+  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 
diff --git a/config/locales/devise.en.yml b/config/locales/devise.en.yml
@@ -45,6 +45,7 @@ en:
       update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and follow the confirmation link to confirm your new email address."
       updated: "Your account has been updated successfully."
       updated_but_not_signed_in: "Your account has been updated successfully, but since your password was changed, you need to sign in again"
+      disabled: "New user registration is not currently enabled."
     sessions:
       signed_in: "Signed in successfully."
       signed_out: "Signed out successfully."
diff --git a/spec/controllers/registrations_controller_spec.rb b/spec/controllers/registrations_controller_spec.rb
@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Users::RegistrationsController, type: :controller do
+  include LoginHelpers
+
+  before(:each) do
+    @request.env['devise.mapping'] = Devise.mappings[:user]
+  end
+
+  context 'when local login is disabled' do
+    before do
+      stub_local_login_setting(enabled: false)
+    end
+
+    it 'does not allow users to register' do
+      post :create, params: {}
+
+      expect(response).to have_http_status(:redirect)
+      expect(flash[:alert]).to include(I18n.t('devise.registrations.disabled'))
+      expect(User.count).to eq 0
+    end
+  end
+
+  context 'local login is enabled' do
+    before do
+      stub_local_login_setting(enabled: true)
+    end
+
+    it 'allows users to register' do
+      u = build(:user)
+
+      expect do
+        post :create, params: {
+          user: {
+            name: u.name,
+            email: u.email,
+            password: u.password,
+            password_confirmation: u.password_confirmation
+          }
+        }
+      end.to change { User.count }.by 1
+
+      expect(flash[:notice]).to eq I18n.t('devise.registrations.signed_up_but_unconfirmed')
+    end
+  end
+end
diff --git a/spec/factories_spec.rb b/spec/factories_spec.rb
@@ -15,7 +15,7 @@
 
       factory.definition.defined_traits.map(&:name).each do |trait_name|
         describe "linting #{trait_name} trait" do
-          skip 'does not raise error when created' do
+          it 'does not raise error when created' do
             expect { create(factory.name, trait_name) }.not_to raise_error
           end
         end
diff --git a/spec/models/users_spec.rb b/spec/models/users_spec.rb
@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe User, type: :model do
+  include LoginHelpers
+
+  describe '.from_omniauth' do
+    context 'when registering using an omniauth provider' do
+      let(:user1) { build(:user) }
+
+      it 'creates the user and sets the user attributes' do
+        auth = mock_omniauth_response(user1)
+        expect { described_class.from_omniauth(auth) }.to change { described_class.count }.by 1
+
+        created_user = described_class.find_by(email: user1.email)
+
+        expect(created_user.email).to eq auth.info.email
+        expect(created_user.name).to eq auth.info.name
+        expect(created_user.provider).to eq auth.provider
+        expect(created_user.provider).to eq auth.provider
+      end
+    end
+
+    context 'when accessing an existing account using an omniauth provider' do
+      let(:user1) { create(:user) }
+
+      it 'does not create a duplicate user' do
+        auth = mock_omniauth_response(user1)
+        expect { described_class.from_omniauth(auth) }.not_to change(described_class, :count)
+      end
+    end
+  end
+end
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
@@ -23,7 +23,7 @@
 # directory. Alternatively, in the individual `*_spec.rb` files, manually
 # require only the support files necessary.
 #
-# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
+Dir[Rails.root.join('spec/support/**/*.rb')].sort.each { |f| require f }
 
 # Checks for pending migrations and applies them before tests are run.
 # If you are not using ActiveRecord, you can remove these lines.
@@ -65,4 +65,8 @@
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
   config.include FactoryBot::Syntax::Methods
+
+  config.include Devise::Test::ControllerHelpers, type: :controller
+
+  config.include StubConfiguration
 end
diff --git a/spec/simplecov_env.rb b/spec/simplecov_env.rb
@@ -4,7 +4,7 @@
 require 'active_support/core_ext/numeric/time'
 
 module SimpleCovEnv
-  extend self
+  module_function
 
   def start!
     return unless ENV['CI']
@@ -24,18 +24,9 @@ def configure_profile
       add_filter 'db/fixtures/'
 
       add_group 'Controllers', 'app/controllers'
-      # add_group 'Finders',     'app/finders'
       add_group 'Helpers',     'app/helpers'
-      # add_group 'Libraries',   'lib'
       add_group 'Mailers',     'app/mailers'
       add_group 'Models',      'app/models'
-      # add_group 'Policies',    'app/policies'
-      # add_group 'Presenters',  'app/presenters'
-      # add_group 'Serializers', 'app/serializers'
-      # add_group 'Services',    'app/services'
-      # add_group 'Uploaders',   'app/uploaders'
-      # add_group 'Validators',  'app/validators'
-      # add_group 'Workers',     %w(app/jobs app/workers)
 
       merge_timeout 365.days
     end
diff --git a/spec/support/helpers/stub_configuration.rb b/spec/support/helpers/stub_configuration.rb
@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module StubConfiguration
+  # Support nested hashes by converting all values into Settingslogic objects
+  def to_settings(hash)
+    hash.transform_values do |value|
+      if value.is_a? Hash
+        Settingslogic.new(value.deep_stringify_keys)
+      else
+        value
+      end
+    end
+  end
+end
diff --git a/spec/support/login_helpers.rb b/spec/support/login_helpers.rb
@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LoginHelpers
+  def stub_ldap_setting(messages)
+    allow(Settings.ldap).to receive_messages(to_settings(messages))
+  end
+
+  def stub_local_login_setting(messages)
+    allow(Settings.local_login).to receive_messages(to_settings(messages))
+  end
+
+  def mock_omniauth_response(user)
+    # This sets up an object that is similar to what LDAP and GitHub return to
+    # the User.from_omniauth method
+    JSON.parse({
+      info: {
+        name: user.name,
+        email: user.email
+      },
+      provider: 'ldap',
+      uid: FFaker::Random.rand(0...1_000_000)
+    }.to_json, object_class: OpenStruct)
+  end
+end

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-web: bundle exec rails s`
	`1`	`+web: bundle exec rails s -p 3000`
`2`	`2`	`webpacker: ./bin/webpack-dev-server`