From 73630643accb5825d3f7fe9912126a275e84068c Mon Sep 17 00:00:00 2001 From: maddiebaka Date: Fri, 13 Oct 2023 19:42:17 -0400 Subject: [PATCH] Add rspec and request tests --- .rspec | 1 + Gemfile | 3 + Gemfile.lock | 30 ++++++++++ bin/rspec | 27 +++++++++ config/routes.rb | 3 +- spec/factories/users.rb | 6 ++ spec/rails_helper.rb | 72 +++++++++++++++++++++++ spec/requests/dictionary_spec.rb | 10 ++++ spec/requests/root_spec.rb | 32 +++++++++++ spec/spec_helper.rb | 94 +++++++++++++++++++++++++++++++ spec/support/controller_macros.rb | 9 +++ spec/support/devise.rb | 6 ++ 12 files changed, 292 insertions(+), 1 deletion(-) create mode 100644 .rspec create mode 100755 bin/rspec create mode 100644 spec/factories/users.rb create mode 100644 spec/rails_helper.rb create mode 100644 spec/requests/dictionary_spec.rb create mode 100644 spec/requests/root_spec.rb create mode 100644 spec/spec_helper.rb create mode 100644 spec/support/controller_macros.rb create mode 100644 spec/support/devise.rb diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..c99d2e7 --- /dev/null +++ b/.rspec @@ -0,0 +1 @@ +--require spec_helper diff --git a/Gemfile b/Gemfile index 8d353d4..47759dc 100644 --- a/Gemfile +++ b/Gemfile @@ -50,6 +50,9 @@ gem "bootsnap", require: false group :development, :test do # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem gem "debug", platforms: %i[ mri windows ] + gem "rspec-rails" + gem "rails-controller-testing" + gem "factory_bot_rails" end group :development do diff --git a/Gemfile.lock b/Gemfile.lock index 7247bef..c93b401 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -96,11 +96,17 @@ GEM railties (>= 4.1.0) responders warden (~> 1.2.3) + diff-lcs (1.5.0) domain_name (0.5.20190701) unf (>= 0.0.5, < 1.0.0) drb (2.1.1) ruby2_keywords erubi (1.12.0) + factory_bot (6.2.1) + activesupport (>= 5.0.0) + factory_bot_rails (6.2.0) + factory_bot (~> 6.2.0) + railties (>= 5.0.0) ffi (1.16.3) ffi-compiler (1.0.1) ffi (>= 1.0.0) @@ -188,6 +194,10 @@ GEM activesupport (= 7.1.1) bundler (>= 1.15.0) railties (= 7.1.1) + rails-controller-testing (1.0.5) + actionpack (>= 5.0.1.rc1) + actionview (>= 5.0.1.rc1) + activesupport (>= 5.0.1.rc1) rails-dom-testing (2.2.0) activesupport (>= 5.0.0) minitest @@ -211,6 +221,23 @@ GEM responders (3.1.1) actionpack (>= 5.2) railties (>= 5.2) + rspec-core (3.12.2) + rspec-support (~> 3.12.0) + rspec-expectations (3.12.3) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.12.0) + rspec-mocks (3.12.6) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.12.0) + rspec-rails (6.0.3) + actionpack (>= 6.1) + activesupport (>= 6.1) + railties (>= 6.1) + rspec-core (~> 3.12) + rspec-expectations (~> 3.12) + rspec-mocks (~> 3.12) + rspec-support (~> 3.12) + rspec-support (3.12.1) ruby2_keywords (0.0.5) sprockets (4.2.1) concurrent-ruby (~> 1.0) @@ -258,11 +285,14 @@ DEPENDENCIES bootsnap debug devise + factory_bot_rails http importmap-rails jbuilder puma (>= 5.0) rails (~> 7.1.1) + rails-controller-testing + rspec-rails sprockets-rails sqlite3 (~> 1.4) stimulus-rails diff --git a/bin/rspec b/bin/rspec new file mode 100755 index 0000000..cb53ebe --- /dev/null +++ b/bin/rspec @@ -0,0 +1,27 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'rspec' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +bundle_binstub = File.expand_path("bundle", __dir__) + +if File.file?(bundle_binstub) + if File.read(bundle_binstub, 300).include?("This file was generated by Bundler") + load(bundle_binstub) + else + abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run. +Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.") + end +end + +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("rspec-core", "rspec") diff --git a/config/routes.rb b/config/routes.rb index 9829d9d..9a9074c 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -1,6 +1,7 @@ Rails.application.routes.draw do devise_for :users - get 'dictionary/index' + #get 'dictionary/index' + resources :dictionary, only: [:index] # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500. diff --git a/spec/factories/users.rb b/spec/factories/users.rb new file mode 100644 index 0000000..cafcd0f --- /dev/null +++ b/spec/factories/users.rb @@ -0,0 +1,6 @@ +FactoryBot.define do + factory :user do + sequence(:username) { |n| "test-#{n.to_s.rjust(3, "0")}@sample.com" } + password { "12345678" } + end +end diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb new file mode 100644 index 0000000..04a6c45 --- /dev/null +++ b/spec/rails_helper.rb @@ -0,0 +1,72 @@ +# This file is copied to spec/ when you run 'rails generate rspec:install' +require 'spec_helper' +ENV['RAILS_ENV'] ||= 'test' +require_relative '../config/environment' +# Prevent database truncation if the environment is production +abort("The Rails environment is running in production mode!") if Rails.env.production? +require 'rspec/rails' +# Add additional requires below this line. Rails is not loaded until this point! + +# Requires supporting ruby files with custom matchers and macros, etc, in +# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are +# run as spec files by default. This means that files in spec/support that end +# in _spec.rb will both be required and run as specs, causing the specs to be +# run twice. It is recommended that you do not name files matching this glob to +# end with _spec.rb. You can configure this pattern with the --pattern +# option on the command line or in ~/.rspec, .rspec or `.rspec-local`. +# +# The following line is provided for convenience purposes. It has the downside +# of increasing the boot-up time by auto-requiring all files in the support +# 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 } + +# Checks for pending migrations and applies them before tests are run. +# If you are not using ActiveRecord, you can remove these lines. +begin + ActiveRecord::Migration.maintain_test_schema! +rescue ActiveRecord::PendingMigrationError => e + abort e.to_s.strip +end +RSpec.configure do |config| + # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures + config.fixture_path = "#{::Rails.root}/spec/fixtures" + + # If you're not using ActiveRecord, or you'd prefer not to run each of your + # examples within a transaction, remove the following line or assign false + # instead of true. + config.use_transactional_fixtures = true + + # Devise and Warden + config.expect_with :rspec do |c| + c.syntax = :expect + end + + config.include Devise::Test::IntegrationHelpers, type: :request + config.include Devise::Test::ControllerHelpers, type: :controller + config.include Warden::Test::Helpers + + # You can uncomment this line to turn off ActiveRecord support entirely. + # config.use_active_record = false + + # RSpec Rails can automatically mix in different behaviours to your tests + # based on their file location, for example enabling you to call `get` and + # `post` in specs under `spec/controllers`. + # + # You can disable this behaviour by removing the line below, and instead + # explicitly tag your specs with their type, e.g.: + # + # RSpec.describe UsersController, type: :controller do + # # ... + # end + # + # The different available types are documented in the features, such as in + # https://rspec.info/features/6-0/rspec-rails + config.infer_spec_type_from_file_location! + + # Filter lines from Rails gems in backtraces. + config.filter_rails_from_backtrace! + # arbitrary gems may also be filtered via: + # config.filter_gems_from_backtrace("gem name") +end diff --git a/spec/requests/dictionary_spec.rb b/spec/requests/dictionary_spec.rb new file mode 100644 index 0000000..daed06f --- /dev/null +++ b/spec/requests/dictionary_spec.rb @@ -0,0 +1,10 @@ +require 'rails_helper' + +RSpec.describe "Dictionary", type: :request do + describe "GET /index" do + it 'renders the index template' do + get "/dictionary" + expect(response).to render_template(:index) + end + end +end diff --git a/spec/requests/root_spec.rb b/spec/requests/root_spec.rb new file mode 100644 index 0000000..88bebfa --- /dev/null +++ b/spec/requests/root_spec.rb @@ -0,0 +1,32 @@ +require 'rails_helper' + +RSpec.describe "Root path", type: :request do + describe "GET /" do + it "works! (now write some real specs)" do + get root_path + expect(response).to have_http_status(200) + end + end + + describe "logged out" do + it "should have 'Register' link" do + get root_path + expect(response.body).to include("Register") + end + end + + describe "logged in" do + it "should have 'Sign Out' link" do + sign_in FactoryBot.create(:user) + get root_path + expect(response.body).to include("Sign Out") + end + + it "should welcome user by username" do + user = FactoryBot.create(:user) + sign_in user + get root_path + expect(response.body).to include(user.username) + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..327b58e --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,94 @@ +# This file was generated by the `rails generate rspec:install` command. Conventionally, all +# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. +# The generated `.rspec` file contains `--require spec_helper` which will cause +# this file to always be loaded, without a need to explicitly require it in any +# files. +# +# Given that it is always loaded, you are encouraged to keep this file as +# light-weight as possible. Requiring heavyweight dependencies from this file +# will add to the boot time of your test suite on EVERY test run, even for an +# individual file that may not need all of that loaded. Instead, consider making +# a separate helper file that requires the additional dependencies and performs +# the additional setup, and require it from the spec files that actually need +# it. +# +# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration +RSpec.configure do |config| + # rspec-expectations config goes here. You can use an alternate + # assertion/expectation library such as wrong or the stdlib/minitest + # assertions if you prefer. + config.expect_with :rspec do |expectations| + # This option will default to `true` in RSpec 4. It makes the `description` + # and `failure_message` of custom matchers include text for helper methods + # defined using `chain`, e.g.: + # be_bigger_than(2).and_smaller_than(4).description + # # => "be bigger than 2 and smaller than 4" + # ...rather than: + # # => "be bigger than 2" + expectations.include_chain_clauses_in_custom_matcher_descriptions = true + end + + # rspec-mocks config goes here. You can use an alternate test double + # library (such as bogus or mocha) by changing the `mock_with` option here. + config.mock_with :rspec do |mocks| + # Prevents you from mocking or stubbing a method that does not exist on + # a real object. This is generally recommended, and will default to + # `true` in RSpec 4. + mocks.verify_partial_doubles = true + end + + # This option will default to `:apply_to_host_groups` in RSpec 4 (and will + # have no way to turn it off -- the option exists only for backwards + # compatibility in RSpec 3). It causes shared context metadata to be + # inherited by the metadata hash of host groups and examples, rather than + # triggering implicit auto-inclusion in groups with matching metadata. + config.shared_context_metadata_behavior = :apply_to_host_groups + +# The settings below are suggested to provide a good initial experience +# with RSpec, but feel free to customize to your heart's content. +=begin + # This allows you to limit a spec run to individual examples or groups + # you care about by tagging them with `:focus` metadata. When nothing + # is tagged with `:focus`, all examples get run. RSpec also provides + # aliases for `it`, `describe`, and `context` that include `:focus` + # metadata: `fit`, `fdescribe` and `fcontext`, respectively. + config.filter_run_when_matching :focus + + # Allows RSpec to persist some state between runs in order to support + # the `--only-failures` and `--next-failure` CLI options. We recommend + # you configure your source control system to ignore this file. + config.example_status_persistence_file_path = "spec/examples.txt" + + # Limits the available syntax to the non-monkey patched syntax that is + # recommended. For more details, see: + # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/ + config.disable_monkey_patching! + + # Many RSpec users commonly either run the entire suite or an individual + # file, and it's useful to allow more verbose output when running an + # individual spec file. + if config.files_to_run.one? + # Use the documentation formatter for detailed output, + # unless a formatter has already been configured + # (e.g. via a command-line flag). + config.default_formatter = "doc" + end + + # Print the 10 slowest examples and example groups at the + # end of the spec run, to help surface which specs are running + # particularly slow. + config.profile_examples = 10 + + # Run specs in random order to surface order dependencies. If you find an + # order dependency and want to debug it, you can fix the order by providing + # the seed, which is printed after each run. + # --seed 1234 + config.order = :random + + # Seed global randomization in this process using the `--seed` CLI option. + # Setting this allows you to use `--seed` to deterministically reproduce + # test failures related to randomization by passing the same `--seed` value + # as the one that triggered the failure. + Kernel.srand config.seed +=end +end diff --git a/spec/support/controller_macros.rb b/spec/support/controller_macros.rb new file mode 100644 index 0000000..e0da1ab --- /dev/null +++ b/spec/support/controller_macros.rb @@ -0,0 +1,9 @@ +module ControllerMacros + def login_user + before(:each) do + @request.env["devise.mapping"] = Devise.mappings[:user] + user = FactoryBot.create(:user) + sign_in user + end + end +end diff --git a/spec/support/devise.rb b/spec/support/devise.rb new file mode 100644 index 0000000..063266c --- /dev/null +++ b/spec/support/devise.rb @@ -0,0 +1,6 @@ +require_relative './controller_macros' + +RSpec.configure do |config| + config.include Devise::Test::ControllerHelpers, type: :controller + config.extend ControllerMacros, type: :controller +end