From d08f3b7f157905c6868406aee1a1cd9a199c781d Mon Sep 17 00:00:00 2001 From: Wineshuga Date: Tue, 12 Dec 2023 14:33:21 +0000 Subject: [PATCH 1/6] Install helpers --- .rspec | 1 + spec/rails_helper.rb | 65 ++++++++++++++++++++++++++++ spec/spec_helper.rb | 98 ++++++++++++++++++++++++++++++++++++++++++ spec/swagger_helper.rb | 43 ++++++++++++++++++ 4 files changed, 207 insertions(+) create mode 100644 .rspec create mode 100644 spec/rails_helper.rb create mode 100644 spec/spec_helper.rb create mode 100644 spec/swagger_helper.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/spec/rails_helper.rb b/spec/rails_helper.rb new file mode 100644 index 0000000..a15455f --- /dev/null +++ b/spec/rails_helper.rb @@ -0,0 +1,65 @@ +# 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. +# +# Rails.root.glob('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_paths = [ + Rails.root.join('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 + + # 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/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..35de9f0 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,98 @@ +# 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! + + # This setting enables warnings. It's recommended, but in some cases may + # be too noisy due to issues in dependencies. + config.warnings = true + + # 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/swagger_helper.rb b/spec/swagger_helper.rb new file mode 100644 index 0000000..14c1214 --- /dev/null +++ b/spec/swagger_helper.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +require 'rails_helper' + +RSpec.configure do |config| + # Specify a root folder where Swagger JSON files are generated + # NOTE: If you're using the rswag-api to serve API descriptions, you'll need + # to ensure that it's configured to serve Swagger from the same folder + config.openapi_root = Rails.root.join('swagger').to_s + + # Define one or more Swagger documents and provide global metadata for each one + # When you run the 'rswag:specs:swaggerize' rake task, the complete Swagger will + # be generated at the provided relative path under openapi_root + # By default, the operations defined in spec files are added to the first + # document below. You can override this behavior by adding a openapi_spec tag to the + # the root example_group in your specs, e.g. describe '...', openapi_spec: 'v2/swagger.json' + config.openapi_specs = { + 'v1/swagger.yaml' => { + openapi: '3.0.1', + info: { + title: 'API V1', + version: 'v1' + }, + paths: {}, + servers: [ + { + url: 'https://{defaultHost}', + variables: { + defaultHost: { + default: 'www.example.com' + } + } + } + ] + } + } + + # Specify the format of the output Swagger file when running 'rswag:specs:swaggerize'. + # The openapi_specs configuration option has the filename including format in + # the key, this may want to be changed to avoid putting yaml in json files. + # Defaults to json. Accepts ':json' and ':yaml'. + config.openapi_format = :yaml +end From 9431d77fb6be406f1ec57787e9718c94d8748e9b Mon Sep 17 00:00:00 2001 From: Wineshuga Date: Tue, 12 Dec 2023 14:35:08 +0000 Subject: [PATCH 2/6] Fix rubocop issues --- spec/rails_helper.rb | 2 +- spec/spec_helper.rb | 100 ++++++++++++++++++++--------------------- spec/swagger_helper.rb | 2 - 3 files changed, 50 insertions(+), 54 deletions(-) diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb index a15455f..ba57c54 100644 --- a/spec/rails_helper.rb +++ b/spec/rails_helper.rb @@ -3,7 +3,7 @@ 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? +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! diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 35de9f0..dc50747 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -44,55 +44,53 @@ # 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! - - # This setting enables warnings. It's recommended, but in some cases may - # be too noisy due to issues in dependencies. - config.warnings = true - - # 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 + # The settings below are suggested to provide a good initial experience + # with RSpec, but feel free to customize to your heart's content. + # # 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! + # + # # This setting enables warnings. It's recommended, but in some cases may + # # be too noisy due to issues in dependencies. + # config.warnings = true + # + # # 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 diff --git a/spec/swagger_helper.rb b/spec/swagger_helper.rb index 14c1214..cb54786 100644 --- a/spec/swagger_helper.rb +++ b/spec/swagger_helper.rb @@ -1,5 +1,3 @@ -# frozen_string_literal: true - require 'rails_helper' RSpec.configure do |config| From 03f47c05dbd0b32cda0a33ebb56148f9dae12d1c Mon Sep 17 00:00:00 2001 From: Wineshuga Date: Tue, 12 Dec 2023 14:35:45 +0000 Subject: [PATCH 3/6] Create cars_controller tests --- spec/requests/api/cars_spec.rb | 116 +++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 spec/requests/api/cars_spec.rb diff --git a/spec/requests/api/cars_spec.rb b/spec/requests/api/cars_spec.rb new file mode 100644 index 0000000..b593ab3 --- /dev/null +++ b/spec/requests/api/cars_spec.rb @@ -0,0 +1,116 @@ +require 'swagger_helper' +require 'rails_helper' + +RSpec.describe 'Api::CarsControllers', type: :request do + before do + post '/api/users', params: { + user: { + username: 'user', + email: 'user@example.com', + password: 'password' + } + } + post '/api/users/sign_in', params: { + user: { + username: 'user', + password: 'password' + } + } + session = JSON.parse(response.body).deep_symbolize_keys + @token = session[:token] + end + + describe 'GET /index' do + it 'returns an array of cars' do + get '/api/all_cars' + json = JSON.parse(response.body) + expect(response.status).to eq(200) + expect(json).to be_a(Array) + end + end + + describe 'GET /show' do + context 'request for an existing car' do + it 'returns a single car' do + car = Car.create(name: 'car', description: 'description of car', pricePerHr: 20, image: 'photo.jpg', + seating_capacity: 3, rental_duration: 3) + get "/api/cars/#{car.id}" + + json = JSON.parse(response.body) + expect(response.status).to eq(200) + expect(json['name']).to eq('car') + expect(json['description']).to eq('description of car') + end + end + + context 'request for a non-existent car' do + it 'returns an error' do + id = 1138 + get "/api/cars/#{id}" + + expect(response.status).to eq(404) + end + end + end + + describe 'POST /create' do + context 'creating a car with the correct parameters' do + it 'creates a car' do + post '/api/car/new_car', params: { + car: { + name: 'test_car', + description: 'description of test_car', + pricePerHr: 20, + image: 'photo.jpg', + seating_capacity: 3, + rental_duration: 3 + } + } + + json = JSON.parse(response.body) + expect(response.status).to eq(201) + expect(json['name']).to eq('test_car') + expect(json['description']).to eq('description of test_car') + end + end + + context 'creating a car with the wrong parameters' do + it 'returns an error message' do + post '/api/car/new_car', params: { + car: { + name: '', + description: '' + } + } + + JSON.parse(response.body) + expect(response.status).to eq(422) + end + end + end + + describe 'DELETE /destroy' do + context 'a delete request for an existing car' do + it 'deletes a car' do + car = Car.create(name: 'car2', description: 'description for car2', pricePerHr: 20, image: 'photo.jpg', + seating_capacity: 3, rental_duration: 3) + delete "/api/cars/#{car.id}", headers: { Authorization: "Bearer #{@token}" } + + json = JSON.parse(response.body) + expect(response.status).to eq(200) + expect(json['message']).to eq('Car marked as removed') + end + end + + context 'a delete request for an non-existent car' do + it 'returns an error message' do + car = Car.create(name: 'car2', description: 'description for car2', pricePerHr: 20, image: 'photo.jpg', + seating_capacity: 3, rental_duration: 3) + Car.destroy(car.id) + delete "/api/cars/#{car.id}", headers: { Authorization: "Bearer #{@token}" } + + expect(response.status).to eq(404) + end + end + end +end From 7da1530c319fa8d88796bd9939f16eb47ae1ac9f Mon Sep 17 00:00:00 2001 From: Wineshuga Date: Tue, 12 Dec 2023 14:36:06 +0000 Subject: [PATCH 4/6] Create my_reservations_controller tests --- spec/requests/api/my_reservations_spec.rb | 66 +++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 spec/requests/api/my_reservations_spec.rb diff --git a/spec/requests/api/my_reservations_spec.rb b/spec/requests/api/my_reservations_spec.rb new file mode 100644 index 0000000..25cb577 --- /dev/null +++ b/spec/requests/api/my_reservations_spec.rb @@ -0,0 +1,66 @@ +require 'swagger_helper' +require 'rails_helper' + +RSpec.describe 'Api::MyReservationsControllers', type: :request do + before do + post '/api/users', params: { + user: { + username: 'user', + email: 'user@example.com', + password: 'password' + } + } + post '/api/users/sign_in', params: { + user: { + username: 'user', + password: 'password' + } + } + session = JSON.parse(response.body).deep_symbolize_keys + @token = session[:token] + end + + describe 'GET /index' do + it 'returns an array of reservations made by the current user' do + get '/api/my_reservations' + JSON.parse(response.body) + expect(response.status).to eq(200) + end + end + + describe 'POST /create' do + context 'creating a reservation with valid parameters' do + it 'creates a reservation' do + car = Car.create(name: 'car', description: 'description of car', pricePerHr: 20, image: 'photo.jpg', + seating_capacity: 3, rental_duration: 3) + post "/api/car/#{car.id}/new_reserve", params: { + my_reservation: { + date: '2024-10-10', + city: 'Lagos' + } + } + + json = JSON.parse(response.body) + expect(response.status).to eq(201) + expect(json['city']).to eq('Lagos') + expect(json['date']).to eq('2024-10-10') + expect(json['car_id']).to eq(car.id) + end + end + + context 'creating a reservation with invalid parameters' do + it 'returns an error' do + car = Car.create(name: 'car', description: 'description of car', pricePerHr: 20, image: 'photo.jpg', + seating_capacity: 3, rental_duration: 3) + post "/api/car/#{car.id}/new_reserve", params: { + my_reservation: { + date: '', + city: '' + } + } + + expect(response.status).to eq(422) + end + end + end +end From 2e36afec12232ce53e8992fb81e3b74c4adb46cd Mon Sep 17 00:00:00 2001 From: Wineshuga Date: Tue, 12 Dec 2023 14:36:27 +0000 Subject: [PATCH 5/6] Create registrations_controller tests --- spec/requests/api/registrations_spec.rb | 38 +++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 spec/requests/api/registrations_spec.rb diff --git a/spec/requests/api/registrations_spec.rb b/spec/requests/api/registrations_spec.rb new file mode 100644 index 0000000..7fd75cf --- /dev/null +++ b/spec/requests/api/registrations_spec.rb @@ -0,0 +1,38 @@ +require 'swagger_helper' +require 'rails_helper' + +RSpec.describe 'Api::RegistrationsControllers', type: :request do + describe 'POST /create' do + context 'when user registration is successful' do + it 'creates a new user' do + post '/api/users/', params: { + user: { + username: 'user', + email: 'user@example.com', + password: 'password' + } + } + + json = JSON.parse(response.body).deep_symbolize_keys + expect(response.status).to eq(200) + expect(json[:message]).to eq('Signup successful') + expect(json[:user][:username]).to eq('user') + end + end + + context 'when user registration fails' do + it 'returns an error message' do + post '/api/users', params: { + user: { + username: '' + } + } + json = JSON.parse(response.body).deep_symbolize_keys + expect(response.status).to eq(422) + expect(json[:errors]).to include("Username can't be blank") + expect(json[:errors]).to include("Email can't be blank") + expect(json[:errors]).to include("Password can't be blank") + end + end + end +end From 08cd76a673bbef9899c9dcc31739ad7ff585ff4d Mon Sep 17 00:00:00 2001 From: Wineshuga Date: Tue, 12 Dec 2023 14:36:43 +0000 Subject: [PATCH 6/6] Create sessions_controller tests --- spec/requests/api/sessions_spec.rb | 46 ++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 spec/requests/api/sessions_spec.rb diff --git a/spec/requests/api/sessions_spec.rb b/spec/requests/api/sessions_spec.rb new file mode 100644 index 0000000..2986ca3 --- /dev/null +++ b/spec/requests/api/sessions_spec.rb @@ -0,0 +1,46 @@ +require 'swagger_helper' +require 'rails_helper' + +RSpec.describe 'Api::SessionsControllers', type: :request do + before do + post '/api/users', params: { + user: { + username: 'user', + email: 'user@example.com', + password: 'password' + } + } + end + + describe 'POST /create' do + context 'successful user login' do + it 'logs a user in' do + post '/api/users/sign_in', params: { + user: { + username: 'user', + password: 'password' + } + } + + json = JSON.parse(response.body).deep_symbolize_keys + expect(response.status).to eq(200) + expect(json[:message]).to eq('Login successful') + end + end + + context 'failed user login' do + it 'returns an error message' do + post '/api/users/sign_in', params: { + user: { + username: 'login_user', + password: 'password' + } + } + + json = JSON.parse(response.body).deep_symbolize_keys + expect(response.status).to eq(401) + expect(json[:message]).to eq('Invalid username or password') + end + end + end +end