diff --git a/lib/swagger_rails/testing/test_case_builder.rb b/lib/swagger_rails/testing/test_case_builder.rb index 4336a6a..775fd5a 100644 --- a/lib/swagger_rails/testing/test_case_builder.rb +++ b/lib/swagger_rails/testing/test_case_builder.rb @@ -46,7 +46,7 @@ module SwaggerRails param_values = param_values_for(parameters, 'path') @path_template.dup.tap do |template| template.prepend(@swagger['basePath'].presence || '') - param_values.each { |name, value| template.sub!("\{#{name}\}", value) } + param_values.each { |name, value| template.sub!("\{#{name}\}", value.to_s) } end end diff --git a/lib/swagger_rails/testing/test_helpers.rb b/lib/swagger_rails/testing/test_helpers.rb index 517002d..086c852 100644 --- a/lib/swagger_rails/testing/test_helpers.rb +++ b/lib/swagger_rails/testing/test_helpers.rb @@ -27,8 +27,8 @@ module SwaggerRails end end - def swagger_test(path, method) - self.class.test_visitor.run_test(path, method, self) + def swagger_test(path, method, &block) + self.class.test_visitor.run_test(path, method, self, &block) end end end diff --git a/spec/dummy/.rspec b/spec/dummy/.rspec new file mode 100644 index 0000000..83e16f8 --- /dev/null +++ b/spec/dummy/.rspec @@ -0,0 +1,2 @@ +--color +--require spec_helper diff --git a/spec/dummy/spec/integration/v1_contract_spec.rb b/spec/dummy/spec/integration/v1_contract_spec.rb new file mode 100644 index 0000000..2d05f30 --- /dev/null +++ b/spec/dummy/spec/integration/v1_contract_spec.rb @@ -0,0 +1,19 @@ +require 'rails_helper' +require 'swagger_rails/testing/test_helpers' + +describe 'V1 Contract' do + include SwaggerRails::TestHelpers + swagger_doc 'v1/swagger.json' + + # TODO: improve DSL + + it 'exposes an API for managing blogs' do + swagger_test '/blogs', 'post' + + swagger_test '/blogs', 'get' + + swagger_test '/blogs/{id}', 'get' do + set id: Blog.last!.id + end + end +end diff --git a/spec/dummy/spec/rails_helper.rb b/spec/dummy/spec/rails_helper.rb new file mode 100644 index 0000000..97096a2 --- /dev/null +++ b/spec/dummy/spec/rails_helper.rb @@ -0,0 +1,53 @@ +# This file is copied to spec/ when you run 'rails generate rspec:install' +ENV['RAILS_ENV'] ||= 'test' +require File.expand_path('../../config/environment', __FILE__) +# Prevent database truncation if the environment is production +abort("The Rails environment is running in production mode!") if Rails.env.production? +require 'spec_helper' +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')].each { |f| require f } + +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 + + # 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://relishapp.com/rspec/rspec-rails/docs + 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/dummy/spec/spec_helper.rb b/spec/dummy/spec/spec_helper.rb new file mode 100644 index 0000000..61e2738 --- /dev/null +++ b/spec/dummy/spec/spec_helper.rb @@ -0,0 +1,92 @@ +# 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. +# +# The `.rspec` file also contains a few flags that are not defaults but that +# users commonly want. +# +# See http://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 + +# The settings below are suggested to provide a good initial experience +# with RSpec, but feel free to customize to your heart's content. +=begin + # These two settings work together to allow 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. + config.filter_run :focus + config.run_all_when_everything_filtered = true + + # 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: + # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/ + # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/ + # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#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/dummy/test/integration/v1_contract_test.rb b/spec/dummy/test/integration/v1_contract_test.rb index 586d94b..23602cc 100644 --- a/spec/dummy/test/integration/v1_contract_test.rb +++ b/spec/dummy/test/integration/v1_contract_test.rb @@ -3,16 +3,17 @@ require 'swagger_rails/testing/test_helpers' class V1ContractTest < ActionDispatch::IntegrationTest include SwaggerRails::TestHelpers - swagger_doc 'v1/swagger.json' -# -# test '/blogs post' do -# swagger_test '/blogs', 'post' -# end - test '/blogs get' do - blog = Blog.create(title: 'Test Blog', content: 'Hello World') + # TODO: improve DSL + + test 'Blogs API' do + swagger_test '/blogs', 'post' swagger_test '/blogs', 'get' + + swagger_test '/blogs/{id}', 'get' do + set id: Blog.last!.id + end end end