katapult 0.2.0 → 0.3.0

data/features/step_definitions/katapult_steps.rb

@@ -1,20 +1,319 @@
 # Note: Aruba adds the project's bin/ directory to the path
 
-When /^I install katapult$/ do
+When 'I install katapult' do
+  next if @no_clobber
   append_to_file 'Gemfile', "gem 'katapult', path: '../../..'"
-  run_simple 'rails generate katapult:install'
 end
 
-# This step is required for any feature because it generates config/database.yml
+When 'I generate the application model' do
+  next if @no_clobber
+  with_aruba_timeout 10 do
+    run_simple 'rails generate katapult:app_model'
+  end
+end
+
 When /^I generate katapult basics$/ do
-  with_aruba_timeout 45 do
-    run_simple 'rails generate katapult:basics --db-user=katapult --db-password=secret'
+  next if @no_clobber
+
+  with_aruba_timeout 60 do
+    run_simple 'rails generate katapult:basics --db-user katapult --db-password secret'
   end
 end
 
-When /^I( successfully)? transform the application model$/ do |require_success|
-  # the second parameter would be true when not specified
-  with_aruba_timeout 45 do
+# By default, transforming the application model will not recreate and migrate
+# the test app database (massive test suite speedup).
+# If a scenario relies on the database being set up (e.g. running Cucumber), be
+# sure to use this step with trailing "including migrations".
+When /^I( successfully)? transform the application model( including migrations)?$/ do |require_success, run_migrations|
+  next if @no_clobber
+
+  ENV['SKIP_MIGRATIONS'] = 'true' unless run_migrations # Speedup
+
+  with_aruba_timeout 60 do
+    # The second argument of #run_simple defaults to `true`
     run_simple 'rails generate katapult:transform lib/katapult/application_model.rb', !!require_success
   end
 end
+After { ENV.delete 'SKIP_MIGRATIONS' }
+
+Then 'Capistrano should be configured' do
+  step 'the file "Capfile" should contain:', <<-CONTENT
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+# Use Git
+require 'capistrano/scm/git'
+install_plugin Capistrano::SCM::Git
+
+# Include tasks from other gems included in your Gemfile
+require 'capistrano/bundler'
+require 'capistrano/maintenance'
+require 'capistrano/rails/assets'
+require 'capistrano/rails/migrations'
+require 'whenever/capistrano'
+
+Dir.glob('lib/capistrano/tasks/*.rake').sort.each do |r|
+  # `import r` calls Rake.application.add_import(r), which imports the file only
+  # *after* this file has been processed, so the imported tasks would not be
+  # available to the hooks below.
+  Rake.load_rakefile r
+end
+
+before 'deploy:updating', 'db:dump'
+after 'deploy:published', 'deploy:restart'
+after 'deploy:published', 'db:warn_if_pending_migrations'
+after 'deploy:published', 'db:show_dump_usage'
+after 'deploy:finished', 'deploy:cleanup' # https://makandracards.com/makandra/1432
+  CONTENT
+
+  step 'the file "config/deploy.rb" should contain:', <<-CONTENT
+# Default value for :format is :pretty
+# set :format, :pretty
+
+set :log_level, :info # %i(debug info error), default: :debug
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for :linked_files is []
+# set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml')
+set :linked_files, %w(config/database.yml config/secrets.yml)
+
+# Default value for linked_dirs is []
+# set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system')
+set :linked_dirs, %w(log public/system tmp/pids)
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+set :application, 'katapult_test_app'
+set :keep_releases, 10
+set :ssh_options, {
+  forward_agent: true
+}
+set :repo_url, 'git@code.makandra.de:makandra/katapult_test_app.git'
+
+# set :whenever_roles, :cron
+# set :whenever_environment, defer { stage }
+# set :whenever_command, 'bundle exec whenever'
+
+set :maintenance_template_path, 'public/maintenance.html.erb'
+CONTENT
+
+  step 'the file "config/deploy/staging.rb" should contain:', <<-CONTENT
+set :stage, :staging
+
+set :deploy_to, '/var/www/katapult_test_app-staging'
+set :rails_env, 'staging'
+set :branch, ENV['DEPLOY_BRANCH'] || 'master'
+
+# server 'example.com', user: 'deploy-user', roles: %w(app web cron db)
+CONTENT
+
+  step 'the file "config/deploy/production.rb" should contain exactly:', <<-CONTENT
+set :stage, :production
+
+set :deploy_to, '/var/www/katapult_test_app'
+set :rails_env, 'production'
+set :branch, 'production'
+
+# server 'one.example.com', user: 'deploy-user', roles: %w(app web cron db)
+# server 'two.example.com', user: 'deploy-user', roles: %w(app web)
+CONTENT
+
+  step 'the file "lib/capistrano/tasks/db.rake" should contain ":warn_if_pending_migrations"'
+  step 'the file "lib/capistrano/tasks/deploy.rake" should contain "Show deployed revision"'
+  step 'the file "lib/capistrano/tasks/passenger.rake" should contain "Restart Application"'
+
+end
+
+Then 'Turbolinks should be removed' do
+  step 'the file "Gemfile" should not contain "turbolinks"'
+  step 'the file "app/views/layouts/application.html.haml" should not contain "turbolinks"'
+end
+
+Then 'the Asset Pipeline should be removed' do
+  step 'the directory "app/assets" should not exist'
+
+  step 'the file "Gemfile" should not contain "sass-rails"'
+  step 'the file "Gemfile" should not contain "therubyracer"'
+end
+
+Then 'Webpacker should be employed' do
+  step 'the file "app/webpack/packs/application.js" should contain "window.$ = jQuery"'
+  step %(the file "app/webpack/assets/index.js" should contain "import './stylesheets/theme'")
+
+  step 'the file "config/webpacker.yml" should contain "source_path: app/webpack"'
+  step 'the file "config/webpack/environment.js" should contain:', <<-CONTENT
+environment.plugins.set('Provide', new webpack.ProvidePlugin({
+    $: 'jquery',
+  CONTENT
+
+  step 'the file "features/support/webpacker.rb" should contain "def compile_once"'
+  step 'the file "package.json" should contain "jquery"'
+  step 'the file "package.json" should contain "bootstrap-sass"'
+
+  step 'the file ".gitignore" should contain "node_modules"'
+end
+
+Then 'the application layout should be set up' do
+  step 'the file "app/views/layouts/application.html.haml" should contain "= query_diet_widget"'
+  step %(the file "app/views/layouts/application.html.haml" should contain "render 'layouts/menu_bar'")
+  step %(the file "app/views/layouts/application.html.haml" should contain "render 'layouts/flashes'")
+  step %(the file "app/views/layouts/application.html.haml" should contain "%body{ data: {env: Rails.env} }")
+  step %(the file "app/views/layouts/application.html.haml" should contain "%html{ lang: I18n.locale }")
+  step %(the file "app/views/layouts/application.html.haml" should contain "width=device-width, initial-scale=1")
+  step %(the file "app/views/layouts/application.html.haml" should contain "%meta(charset='utf-8')")
+
+  step 'the file "app/views/layouts/_flashes.html.haml" should contain:', <<~CONTENT
+  - flash.each do |_level, message|
+    .flash.alert.alert-info
+      = message
+  CONTENT
+end
+
+Then 'Unpoly should be installed' do
+  step 'the file "package.json" should contain "unpoly"'
+  step 'a file named "config/webpack/loaders/unpoly.js" should exist'
+
+  step %(the file "app/webpack/packs/application.js" should contain "import 'unpoly/dist/unpoly'")
+  step %(the file "app/webpack/packs/application.js" should contain "import 'unpoly/dist/unpoly-bootstrap3'")
+  step %(the file "app/webpack/assets/index.js" should contain "import './stylesheets/unpoly'")
+  step 'the file "app/webpack/assets/javascripts/unpoly.js" should contain "up.motion.config.enabled = false"'
+  step 'the file "app/webpack/assets/stylesheets/unpoly.sass" should contain "@import ~unpoly/dist/unpoly"'
+  step 'the file "app/webpack/assets/stylesheets/unpoly.sass" should contain "@import ~unpoly/dist/unpoly-bootstrap3"'
+
+  step 'the file "app/helpers/unpoly_helper.rb" should contain "def content_link_to"'
+  step 'the file "app/helpers/unpoly_helper.rb" should contain "def modal_link_to"'
+  step 'a file named "app/webpack/assets/javascripts/macros/content_link.js" should exist'
+  step 'a file named "app/webpack/assets/javascripts/macros/modal_link.js" should exist'
+  step 'a directory named "app/webpack/assets/javascripts/compilers" should exist'
+end
+
+Then 'styles should be prepared' do
+  step 'the file "app/webpack/assets/stylesheets/theme.sass" should contain "body"'
+  step 'the file "app/webpack/assets/stylesheets/custom_bootstrap.sass" should contain "@import ~bootstrap-sass/assets/stylesheets/bootstrap/normalize"'
+  step 'the file "app/webpack/assets/stylesheets/_environment.sass" should contain:', <<-CONTENT
+@import definitions
+@import mixins
+
+  CONTENT
+  step 'a file named "app/webpack/assets/stylesheets/_mixins.sass" should exist'
+  step 'a file named "app/webpack/assets/stylesheets/_definitions.sass" should exist'
+
+  step 'a directory named "app/webpack/assets/stylesheets/blocks" should exist'
+  step 'a directory named "app/webpack/assets/stylesheets/ext" should exist'
+
+  # JS support for Bootstrap dropdowns
+  step %(the file "app/webpack/assets/javascripts/bootstrap.js" should contain "import 'bootstrap-sass/assets/javascripts/bootstrap/dropdown'")
+end
+
+Then 'binstubs should be set up' do
+  binaries = %w[rails rake rspec cucumber]
+
+  binaries.each do |binary|
+    step %(the file "bin/#{binary}" should contain:), <<-CONTENT
+#!/usr/bin/env ruby
+running_in_parallel = ENV.has_key?('TEST_ENV_NUMBER') || ARGV.any? { |arg| arg =~ /^parallel:/ }
+
+begin
+  load File.expand_path('../spring', __FILE__) unless running_in_parallel
+rescue LoadError => e
+    CONTENT
+  end
+end
+
+Then 'the test environment should be configured' do
+  step 'the file "config/environments/test.rb" should contain "config.eager_load = true"'
+  step 'the file "config/environments/test.rb" should contain "config.consider_all_requests_local = false"'
+  step 'the file "config/environments/test.rb" should contain "config.action_controller.perform_caching = true"'
+  # Default is "true"
+  step 'the file "config/environments/test.rb" should not contain "config.action_controller.allow_forgery_protection"'
+end
+
+Then 'features/support should be prepared' do
+  step 'the file "features/support/cucumber_factory.rb" should contain "Cucumber::Factory.add_steps(self)"'
+  step 'the file "features/support/factory_bot.rb" should contain "World(FactoryBot::Syntax::Methods)"'
+  step %(the file "features/support/rspec_doubles.rb" should contain "require 'cucumber/rspec/doubles'")
+  step %(the file "features/support/spreewald.rb" should contain "require 'spreewald/all_steps'")
+
+  step 'a file named "features/support/paths.rb" should exist'
+  step 'a file named "features/support/selectors.rb" should exist'
+  step 'the file "spec/spec_helper.rb" should match /^Dir.Rails.root.join.+spec.support/'
+  step 'the file ".rspec" should contain "--require spec_helper"'
+  step 'the file ".rspec_parallel" should contain "--require spec_helper"'
+
+  step 'the file "features/support/selenium.rb" should contain "--mute-audio"'
+  step 'the file "features/support/selenium.rb" should contain "--disable-infobars"'
+  step 'the file "features/support/selenium.rb" should contain:', <<-CONTENT
+Capybara.register_driver :selenium do |app|
+  Capybara::Selenium::Driver.new(app,
+    browser: :chrome,
+    args: chrome_args,
+    prefs: no_password_bubble
+  )
+end
+  CONTENT
+
+  step 'the file "features/support/capybara_screenshot.rb" should contain:', <<-CONTENT
+require 'capybara-screenshot/cucumber'
+
+# Keep up to the number of screenshots specified in the hash
+Capybara::Screenshot.prune_strategy = { keep: 10 }
+  CONTENT
+
+  step 'the file "features/support/database_cleaner.rb" should contain:', <<-CONTENT
+DatabaseCleaner.clean_with(:deletion) # clean once, now
+DatabaseCleaner.strategy = :transaction
+Cucumber::Rails::Database.javascript_strategy = :deletion
+  CONTENT
+end
+
+Then 'spec/support should be prepared' do
+  step 'a file named "spec/support/postgresql_sequences.rb" should exist'
+  step 'the file "spec/support/fixture_file.rb" should contain "def fixture_file"'
+  step 'the file "spec/support/database_cleaner.rb" should contain "DatabaseCleaner.clean_with"'
+
+  step 'the file "spec/support/shoulda_matchers.rb" should contain:', <<-CONTENT
+require 'shoulda/matchers'
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end
+  CONTENT
+
+  step 'the file "spec/support/factory_bot.rb" should contain:', <<-CONTENT
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end
+  CONTENT
+
+  step 'the file "spec/support/timecop.rb" should contain:', <<-CONTENT
+RSpec.configure do |config|
+  config.after { Timecop.return }
+end
+  CONTENT
+end
+
+Then 'initializers should be installed' do
+  step 'the file "config/initializers/better_errors.rb" should contain "BetterErrors::ErrorPage.prepend(BetterErrorsHugeInspectWarning)"'
+
+  step 'the file "config/initializers/exception_notification.rb" should contain:', <<-CONTENT
+ExceptionNotification.configure do |config|
+
+  config.add_notifier :email, {
+    email_prefix: '[katapult_test_app] ',
+    exception_recipients: %w[fail@makandra.de],
+  CONTENT
+end
+
+Then 'the errors controller should be installed' do
+  step 'a file named "app/controllers/errors_controller.rb" should exist'
+  step 'the file "config/routes.rb" should contain "resources :errors, only: :new"'
+end

data/features/step_definitions/rails_steps.rb

@@ -1,6 +1,11 @@
 require 'katapult/binary_util'
 
-module KatapultRailsHelper
+module RailsHelper
+
+  # Directory names
+  TEST_APP = 'katapult_test_app'
+  APP_WITH_BASICS = 'cached_test_app_with_basics'
+  PRISTINE_APP = 'cached_pristine_test_app'
 
   def with_aruba_timeout(timeout, &block)
     original_aruba_timeout = aruba.config.exit_timeout
@@ -12,12 +17,13 @@ module KatapultRailsHelper
     aruba.config.exit_timeout = original_aruba_timeout
   end
 
-  def create_cached_app(name)
-    job = 'Cached Rails app generation'
-
-    puts "#{job} started (in #{Dir.pwd})"
+  def create_app(name)
     Katapult::BinaryUtil.create_rails_app(name)
-    puts "#{job} done."
+    puts 'Done generating rails app.'
+  end
+
+  def test_app_path
+    File.join expand_path('.'), TEST_APP
   end
 
   def ensure_bundled(path)
@@ -28,19 +34,73 @@ module KatapultRailsHelper
     end
   end
 
+  def recreate_databases(path)
+    Dir.chdir(path) do
+      # Katapult doesn't run test app tests in parallel
+      Katapult::BinaryUtil.run 'bundle exec rake db:drop db:create > /dev/null'
+    end
+  end
+
 end
-World(KatapultRailsHelper)
+World(RailsHelper)
 
+# In these steps, cached Rails apps are created to speed up test runs.
+#
+# Note: The current Ruby process and Aruba have *different* opinions about the
+# current working directory:
+# - Ruby knows the "real" Dir.pwd
+# - Aruba is scoped to its test directory "tmp/aruba"
 
 Given /^a pristine Rails application$/ do
-  with_aruba_timeout(120) do
-    Dir.chdir('tmp') do
-      create_cached_app('cached_test_app') unless File.directory?('cached_test_app')
-      ensure_bundled('cached_test_app')
+  unless @no_clobber
+    with_aruba_timeout(80) do
+      # Change Ruby cwd
+      Dir.chdir('tmp') do
+        if File.directory?(RailsHelper::PRISTINE_APP)
+          puts "Using a cached Rails app from tmp/#{RailsHelper::PRISTINE_APP}"
+        else
+          create_app(RailsHelper::PRISTINE_APP)
+        end
+
+        ensure_bundled(RailsHelper::PRISTINE_APP)
+        FileUtils.cp_r RailsHelper::PRISTINE_APP, test_app_path
+      end
     end
+  end
+
+  cd RailsHelper::TEST_APP # Change Aruba cwd
+end
+
+Given 'a new Rails application with Katapult basics installed' do
+  unless @no_clobber
+    with_aruba_timeout(120) do
+      # Change Ruby cwd
+      Dir.chdir('tmp') do
+        if File.directory?(RailsHelper::APP_WITH_BASICS)
+          puts <<-NOTE
+  Using a cached Rails app with basics installed. Remember to
+    rm -rf tmp/#{RailsHelper::APP_WITH_BASICS}
+  when modifying the basics generator.
+        NOTE
+        else
+          create_app(RailsHelper::APP_WITH_BASICS)
 
-    # copy cached app to aruba directory
-    FileUtils.cp_r 'tmp/cached_test_app', File.join(expand_path('.'), 'katapult_test_app')
-    cd 'katapult_test_app' # Aruba::Api method
+          Dir.chdir(RailsHelper::APP_WITH_BASICS) do
+            # :path will be correct when copied to the TEST_APP path
+            Katapult::BinaryUtil.run %(echo "gem 'katapult', path: '../../..'" >> Gemfile)
+            Katapult::BinaryUtil.run 'bin/rails generate katapult:basics --db-user katapult --db-password secret'
+            # Spring running in the cache dir is of no further use, but would
+            # break things when the cache dir is removed
+            Katapult::BinaryUtil.run 'spring stop'
+          end
+        end
+
+        ensure_bundled(RailsHelper::APP_WITH_BASICS)
+        recreate_databases(RailsHelper::APP_WITH_BASICS)
+        FileUtils.cp_r RailsHelper::APP_WITH_BASICS, test_app_path
+      end
+    end
   end
+
+  cd RailsHelper::TEST_APP # Change Aruba cwd
 end

data/features/step_definitions/test_steps.rb

@@ -1,11 +1,11 @@
 When /^I run rspec/ do
-  run_simple 'rspec'
+  run_simple 'rspec', exit_timeout: 10
 end
 
 When /^I run cucumber/ do
-  # The test application's Bundler sees an empty BUNDLE_GEMFILE variable and
-  # infers the wrong Gemfile location. Fixed by removing the var altogether.
-  delete_environment_variable 'BUNDLE_GEMFILE'
+  run_simple 'bundle exec cucumber', exit_timeout: 15
+end
 
-  run_simple 'bundle exec cucumber'
+When 'debugger' do
+  binding.pry
 end

data/features/step_definitions/version_steps.rb

@@ -0,0 +1,22 @@
+Then 'the ruby-version file should be up-to-date' do
+  configured_ruby = File.read('.ruby-version').strip
+  expect(configured_ruby).to eq Katapult::RUBY_VERSION
+end
+
+Then 'the configured Rails version should be listed in the Gemfile.lock' do
+  rails_version = Katapult::RAILS_VERSION
+  step %(the file "Gemfile.lock" should contain "    rails (#{rails_version})")
+end
+
+Then 'the output should contain the configured Rails version' do
+  step %(the output should contain "Using rails #{Katapult::RAILS_VERSION}")
+end
+
+Then 'Capistrano should be locked to the installed version' do
+  cd '.' do
+    gemfile = File.read('Gemfile.lock')
+    version = gemfile[/^    capistrano \((.*)\)$/, 1]
+
+    step %(the file "config/deploy.rb" should contain "lock '#{version}'")
+  end
+end

data/features/support/env.rb

@@ -5,14 +5,22 @@ require 'pry'
 ENV['KATAPULT_GEMFILE_OPTIONS'] = ", path: '../../..'"
 
 Aruba.configure do |config|
-  config.exit_timeout = 30 # Todo: decrease to ~5
+  config.exit_timeout = 5
 end
 
-Before do
-  unset_bundler_env_vars # Don't use katapult's Bundler environment inside tests
+Before do |scenario|
+  # Don't reuse the Bundler environment of *katapult* during tests
+  bundler_env_keys = aruba.environment.keys.grep /^BUNDLE/
+  bundler_env_keys.each &method(:delete_environment_variable)
+
   run_simple 'spring stop # Ensure Spring is not running'
+
+  scenario_tags = scenario.source_tag_names
+  @no_clobber = scenario_tags.include? '@no-clobber'
 end
 
 After do
+  # Spring doesn't like loosing its working directory. Since the test app
+  # directory is clobbered between runs, we stop Spring after each run.
   run_simple 'spring stop'
 end