appmap 0.35.2 → 0.39.0

data/spec/fixtures/rails6_users_app/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  namespace :api do
+    resources :users, only: %i[index create]
+  end
+
+  resources :users, only: %i[index show]
+
+  get 'health', to: 'health#show'
+
+  root 'users#index'
+end

data/spec/fixtures/rails6_users_app/create_app

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+set -e
+
+# Just checking for a healthy container isn't enough, apparently. If
+# we don't wait here, sometimes the database is inaccessible.
+for i in {1..10}; do
+  psql -h pg -U postgres postgres -c 'select 1' >/dev/null 2>&1 && break
+  printf ' .'
+  sleep 1
+done
+echo
+out="$(psql -h pg -U postgres postgres -c 'select 1' 2>&1)"
+if [[ $? != 0 ]]; then
+   echo "Postgres didn't start in time:"
+   echo "$out"
+   exit 1
+fi
+
+psql -h pg -U postgres -c "create database app_development"
+psql -h pg -U postgres -c "create database app_test"
+
+set -e
+
+RAILS_ENV=development ./bin/rake db:migrate
+RAILS_ENV=test ./bin/rake db:migrate
+
+echo "INSERT INTO users ( login ) VALUES ( 'admin' )  " | psql -h pg -U postgres app_development

data/spec/fixtures/rails6_users_app/db/migrate/20190728211408_create_users.rb

@@ -0,0 +1,9 @@
+Sequel.migration do
+  change do
+    create_table :users do
+      primary_key :id
+      text :login, null: false, unique: true
+      column :password_digest, :bytea
+    end
+  end
+end

data/spec/fixtures/rails6_users_app/db/schema.rb

@@ -0,0 +1,23 @@
+Sequel.migration do
+  change do
+    create_table(:schema_migrations) do
+      column :filename, "text", :null=>false
+      
+      primary_key [:filename]
+    end
+    
+    create_table(:users) do
+      primary_key :id
+      column :login, "text", :null=>false
+      column :password_digest, "bytea"
+      
+      index [:login], :name=>:users_login_key, :unique=>true
+    end
+  end
+end
+Sequel.migration do
+  change do
+    self << "SET search_path TO \"$user\", public"
+    self << "INSERT INTO \"schema_migrations\" (\"filename\") VALUES ('20190728211408_create_users.rb')"
+  end
+end

data/spec/fixtures/rails6_users_app/docker-compose.yml

@@ -0,0 +1,28 @@
+version: "3"
+services:
+  pg:
+    build:
+      context: .
+      dockerfile: Dockerfile.pg
+    ports:
+      - "5432"
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: trust
+
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    image: rails-app:${RUBY_VERSION}
+    command:
+      [ "./bin/rails", "server", "-b", "0.0.0.0", "webrick" ]
+    environment:
+      RAILS_ENV:
+      ORM_MODULE:
+      APPMAP:
+    volumes:
+    - .:/src/app
+    ports:
+    - "3000"
+    links:
+    - pg:pg

data/spec/fixtures/rails6_users_app/features/api_users.feature

@@ -0,0 +1,13 @@
+Feature: /api/users
+
+  @appmap-disable
+  Scenario: A user can be created
+    When I create a user
+    Then the response status should be 201
+
+  Scenario: When a user is created, it should be in the user list
+    Given I create a user
+    And the response status should be 201
+    When I list the users
+    Then the response status should be 200
+    And the response should include the user

data/spec/fixtures/rails6_users_app/features/support/env.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'cucumber/rails'
+require 'appmap/cucumber'

data/spec/fixtures/rails6_users_app/features/support/hooks.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+if AppMap::Cucumber.enabled?
+  Around('not @appmap-disable') do |scenario, block|
+    appmap = AppMap.record do
+      block.call
+    end
+
+    AppMap::Cucumber.write_scenario(scenario, appmap)
+  end
+end

data/spec/fixtures/rails6_users_app/features/support/steps.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+When 'I create a user' do
+  @response = post '/api/users', login: 'alice'
+end
+
+Then(/the response status should be (\d+)/) do |status|
+  expect(@response.status).to eq(status.to_i)
+end
+
+When 'I list the users' do
+  @response = get '/api/users'
+  @users = JSON.parse(@response.body)
+end
+
+Then 'the response should include the user' do
+  expect(@users.map { |u| u['login'] }).to include('alice')
+end

data/spec/fixtures/rails6_users_app/public/robots.txt

@@ -0,0 +1 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_api_spec.rb

@@ -0,0 +1,29 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller, appmap: true do
+  describe 'POST /api/users', feature: 'Create a user' do
+    describe 'with required parameters' do
+      it 'creates a user' do
+        post :create, params: { login: 'alice', password: 'foobar' }
+        expect(response.status).to eq(201)
+      end
+    end
+    describe 'with a missing parameter' do
+      it 'reports error 422' do
+        post :create, params: {}
+        expect(response.status).to eq(422)
+      end
+    end
+  end
+  describe 'GET /api/users', feature: 'List users' do
+    before do
+      post :create, params: { login: 'alice' }
+    end
+    it 'lists the users' do
+      get :index, params: {}
+      users = JSON.parse(response.body)
+      expect(users.map { |r| r['login'] }).to include('alice')
+    end
+  end
+end

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe UsersController, type: :controller do
+  render_views
+
+  describe 'GET /users', feature: 'Show all users' do
+    before do
+      User.create login: 'alice'
+    end
+    it 'lists the users' do
+      get :index
+      expect(response).to be_ok
+    end
+  end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
+end

data/spec/fixtures/rails6_users_app/spec/models/user_spec.rb

@@ -0,0 +1,39 @@
+require 'rails_helper'
+
+describe User, feature_group: 'User', appmap: true do
+  # TODO: appmap/rspec doesn't handle shared_examples_for 100% correctly yet.
+  # In my tests, only one of these two tests will be emitted as an appmap.
+  shared_examples_for 'creates the user' do |username|
+    let(:login) { username }
+    let(:user) { User.new(login: login) }
+    it "creates #{username.inspect}" do
+      expect(user.save(raise_on_failure: true)).to be_truthy
+    end
+  end
+
+  describe 'creation', feature: 'Create a user' do
+    context 'using shared_examples_for' do
+      # AppMap.
+#      context "with username 'alice'" do
+#        it_should_behave_like 'creates the user', 'alice'
+#      end
+#      context "with username 'bob'" do
+#        it_should_behave_like 'creates the user', 'bob'
+#      end
+    end
+
+    # So, instead of shared_examples_for, let's go with a simple method
+    # containing the assertions. The method can be called from within an example.
+    def save_and_verify
+      expect(user.save(raise_on_failure: true)).to be_truthy
+    end
+
+    context do
+      let(:login) { 'charles' }
+      let(:user) { User.new(login: login) }
+      it "creates 'charles'" do
+        save_and_verify
+      end
+    end
+  end
+end

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -0,0 +1,66 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+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 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+require 'appmap/rspec'
+
+# 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|
+  # 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")
+
+
+  DatabaseCleaner.allow_remote_database_url = true
+  
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around :each do |example|
+    # Enable the use of 'return' from a guard
+    -> {
+      return example.run unless %i[model controller].member?(example.metadata[:type])
+
+      DatabaseCleaner.cleaning do
+        example.run
+      end
+    }.call
+  end
+end

data/spec/fixtures/rails6_users_app/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# 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 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
+
+  # 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:
+  #   - 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

data/spec/fixtures/rails6_users_app/users_app/.gitignore

@@ -0,0 +1,20 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key