specimen 0.0.1.alpha.b → 0.0.3.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '091d4e836ac67953118af5d330c4254d7e29716b7cb3e2756369b45a0ba74a88'
-  data.tar.gz: 69249e8db11054399bbc70c2fdee9163b9cbac769ae79ed55182c61f4083448a
+  metadata.gz: 7c0a28521622f9720868bc538c48567cd6ee1b290dc0939572d0af33d2ef2ecf
+  data.tar.gz: 6d7042ab4f3bd81237694a93ddd7641772a2381597a3185ea258b536616de895
 SHA512:
-  metadata.gz: 83f173e5ecfe205b8581e18851aed9de5e0e19f52c995790f53af3316d7e16238d8ff02104339c360caf0db07916347c157664c955522bc89b6ad2a6c28dbcbe
-  data.tar.gz: 0ab049182afb589bfe054d0325114cd0d3536c4ec9990df0e222bfd5ef8713e93b2e901dbf2ae534794e9fda09d5bd4a42a87e778d8142346ea6f1bd50d817fc
+  metadata.gz: 1c53ce47754279e09e849511566fe515d1ed64842653f24beb631a430e77b855249a51a6eee1b7a83b2197be888a8487d97f355028e827e7ac776a87f78aed7f
+  data.tar.gz: aa5615ac6bf581885ae77d4c0321cf0a3473489b25b096684c307817bee0fe406c27bb584aab04a36b7d84bcf236c6a14948b510f7f12c06a9fbb1a5b601bc7a

data/README.md

@@ -8,36 +8,77 @@ will help me with:
 - provide a Rails like templating approach in terms of _convention over configuration_ to provide a maintainable base for
   API or UI tests using RSpec and/or Cucumber.
 
+## specimen commands
 
-**Beware**
+```shell
+❯ specimen
+Usage:
+  specimen COMMAND [options]
 
-At the point of writing the README and setting the repo to public, the gem does not do much yet so the current functionality
-is minimal, not optimized and not tested :). Hopefully that will change in the future.
+You must specify a command:
 
-```shell
-# install Specimen gem
-$> gem install specimen
+  init         Initialize a new specimen project
+  cukes        Run Cucumber tests (WIP)
+  specs        Run RSpec tests (WIP)
+  exec         Run tests via a config file (WIP)
 
-# creates a new project relative to the current working directory. Will ask for a project name.
-$> specimen init
+All commands can be run with -h (or --help) for more information.
+```
 
-# creates a new project 'foobar' relative to the current working directory.
-# Inside /foobar you will find the default dir structures for Cucumber and RSpec tests and a few more files
-$> specimen init -n foobar
+### specimen init
 
-# look at the command help
-$> specimen help init
+```shell
+❯ specimen init -h
 Usage:
-  specimen init
+  specimen init --name=NAME [options]   # Create a new specimen project which will generate following dirs and files
+
+                                          * default directories /config, /lib, /tmp
+                                          * default directories (/features/..) and files for cucumber unless --skip-cucumber
+                                          * default directories (/spec/..) and files for RSpec unless --skip-rspec
+                                          * root path files:
+                                            * .gemrc
+                                            * .gitignore
+                                            * .rspec (unless --skip-rspec)
+                                            * .rubocop.yml
+                                            * cucumber.yml (unless --skip-cucumber)
+                                            * Gemfile (based on the used options)
+                                            * README.md
+                                            * specimen.yml (default configuration file for the specimen gem
 
 Options:
-  --name, -n, [--project-name=PROJECT_NAME]
-              [--api-only], [--no-api-only], [--skip-api-only]  # Default: false  
-              [--cucumber], [--no-cucumber], [--skip-cucumber]  # Default: true
+  -n, [--name=NAME]                     # required: true
+                                          The name of your project and installation path relative to your current PWD
+
+      [--ui-driver=UI_DRIVER]           # Default: 'watir'
+                                          Valid options are:
+                                            * watir
+                                            * selenium
+                                            * selenium-webdriver
+
+      [--skip-ui]                       # Default: false
+                                          Don´t add selenium or watir gem to your Gemfile
+
+      [--skip-cucumber]                 # Default: false
+                                          No cucumber gems will be added to your Gemfile.
+                                          Creation of cucumber directories and files will be skipped.
+
+      [--skip-rspec]                    # Default: false
+                                          RSpec will still be in your Gemfile (as it´s matchers are used for cucumber)
+                                          but no RSpec directories and files will be generated
 ```
 
+### specimen cukes
+
+TBD
+
+### specimen specs
+
+TBD
+
+### specimen exec
+
+TBD
 
 ### Known issues
 
-- tests are missing
-- generated Gemfile contains Watir and Selenium webdriver, it should be only one of them.
+- tests are missing

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha.b
+0.0.3.alpha

data/bin/specimen

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-lib_path = File.expand_path('..', __dir__) + '/lib'
+lib_path = "#{File.expand_path('..', __dir__)}/lib"
 $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
 require 'specimen/cli'
-Specimen::CLI.start!(ARGV.dup)

data/lib/specimen/cli.rb

@@ -1,25 +1,11 @@
 # frozen_string_literal: true
 
 require 'specimen'
-require 'specimen/cli/default_command'
 
-module Specimen
-  module CLI
-    class << self
-      def start!(args = ARGV)
-        command = args.shift
+config = {
+  verbose: ENV.key?('VERBOSE'),
+  strict: ENV.key?('STRICT'),
+  log_level: ENV.key?('LOG_LEVEL') ? ENV.fetch('LOG_LEVEL').to_sym : :info
+}
 
-        case command
-        when '--version', '-v'
-          show_version
-        else
-          DefaultCommand.start(ARGV.dup)
-        end
-      end
-
-      def show_version
-        puts(Specimen::VERSION::STRING)
-      end
-    end
-  end
-end
+Specimen::Command.execute!(ARGV.dup, config)

data/lib/specimen/command/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class Base < Thor
+      include Thor::Actions
+
+      class << self
+        def exit_on_failure?
+          false
+        end
+      end
+
+      no_commands do
+        def usage_path
+          find_in_source_paths('USAGE')
+        rescue Thor::Error
+          ''
+        end
+
+        def usage_content
+          return '' if usage_path.empty?
+
+          File.read(usage_path)
+        end
+
+        def class_usage
+          return nil if usage_content.empty?
+
+          ERB.new(usage_content, trim_mode: '-').result(binding)
+        end
+      end
+    end
+  end
+end

data/lib/specimen/command/base_group.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class BaseGroup < Thor::Group
+      include Thor::Actions
+
+      class << self
+        def exit_on_failure?
+          false
+        end
+      end
+
+      no_commands do
+        def usage_path
+          find_in_source_paths('USAGE')
+        rescue Thor::Error
+          ''
+        end
+
+        def usage_content
+          return '' if usage_path.empty?
+
+          File.read(usage_path)
+        end
+
+        def class_usage
+          return nil if usage_content.empty?
+
+          ERB.new(usage_content, trim_mode: '-').result(binding)
+        end
+      end
+    end
+  end
+end

data/lib/specimen/command/exec_command_builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class ExecCommandBuilder
+      attr_reader :config
+
+      def initialize(config:, framework: nil, tests_path: '')
+        @framework = framework
+        @config = config
+        @tests_path = tests_path
+      end
+
+      def build_cmd
+        raise 'Undefined framework' if base_cmd.nil?
+
+        "#{env_string} #{base_cmd} #{options_string} #{@tests_path}".strip
+      end
+
+      def base_cmd
+        config['framework'] || @framework
+      end
+
+      def env_vars
+        config['env'] || []
+      end
+
+      def command_options
+        config['options'] || []
+      end
+
+      def env_string
+        return '' unless env_vars.any?
+
+        env_vars.join(' ')
+      end
+
+      def options_string
+        return '' unless command_options.any?
+
+        command_options.map(&:to_s).join(' ')
+      end
+    end
+  end
+end

data/lib/specimen/command/runner/cukes_runner.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class CukesRunner < PathRunner
+      no_commands do
+        def perform
+          super
+
+          check_config_not_nil!
+          inside runtime.work_dir do
+            run(exec_cmd)
+          end
+        end
+
+        def framework
+          profile_config['framework'] || 'cucumber'
+        end
+
+        def profile_name
+          profile? ? profile : 'cucumber'
+        end
+      end
+    end
+  end
+end

data/lib/specimen/command/runner/exec_runner.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class ExecRunner < TestRunner
+      class_option :profile, aliases: %w[-p], type: :string
+
+      no_commands do
+        def perform
+          super
+
+          run_profile_check!
+          check_config_not_nil!
+          inside runtime.work_dir do
+            run(exec_cmd)
+          end
+        end
+
+        def tests_path
+          ''
+        end
+
+        def run_profile_check!
+          raise "Missing command option '--profile|-p'" unless profile?
+        end
+
+        def framework
+          profile_config['framework'] || nil
+        end
+
+        def profile_name
+          profile? ? profile : nil
+        end
+      end
+    end
+  end
+end

data/lib/specimen/command/runner/path_runner.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class PathRunner < TestRunner
+      argument :path, type: :string, default: ''
+
+      no_commands do
+        def arg_is_command_option?
+          return false if path.empty?
+
+          path.start_with?('--', '-')
+        end
+
+        def tests_path
+          return @tests_path if @tests_path
+          return '' if arg_is_command_option?
+
+          @tests_path = path
+        end
+      end
+    end
+  end
+end

data/lib/specimen/command/runner/specs_runner.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class SpecsRunner < PathRunner
+      no_commands do
+        def perform
+          super
+          check_config_not_nil!
+          inside runtime.work_dir do
+            run(exec_cmd)
+          end
+        end
+
+        def framework
+          profile_config['framework'] || 'rspec'
+        end
+
+        def profile_name
+          profile? ? profile : 'rspec'
+        end
+      end
+    end
+  end
+end

data/lib/specimen/command/test_runner.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class TestRunner < BaseGroup
+      class ProfileDataNilError < RuntimeError
+        def initialize(profile_name, yml_name)
+          @msg = "No data found in '#{yml_name}' for profile: '#{profile_name}'"
+          super(@msg)
+        end
+      end
+
+      class_option :config_file, aliases: %w[-C --config], type: :string, default: 'specimen.yml'
+
+      no_commands do
+        def perform
+          runtime
+        end
+
+        def runtime
+          return @runtime if @runtime
+
+          runtime = Runtime.start!(self)
+          Specimen.runtime = runtime
+          @runtime = runtime
+        end
+
+        def framework
+          nil
+        end
+
+        def profile
+          options[:profile]
+        end
+
+        def profile?
+          !profile.nil?
+        end
+
+        def profile_config
+          runtime.profile_yml_data(profile_name)
+        end
+
+        def profile_name
+          profile? ? profile : nil
+        end
+
+        def exec_cmd
+          ExecCommandBuilder.new(config: profile_config, framework:, tests_path:).build_cmd
+        end
+
+        def check_config_not_nil!
+          raise ProfileDataNilError.new(profile_name, runtime.yml_name) if profile? && profile_config.nil?
+        end
+      end
+    end
+  end
+end

data/lib/specimen/command.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'thor'
+
+require 'specimen/command/base'
+require 'specimen/command/base_group'
+require 'specimen/command/test_runner'
+require 'specimen/command/exec_command_builder'
+require 'specimen/command/runner/path_runner'
+require 'specimen/command/runner/cukes_runner'
+require 'specimen/command/runner/exec_runner'
+require 'specimen/command/runner/specs_runner'
+
+require 'specimen/commands/cukes/cukes_command'
+require 'specimen/commands/exec/exec_command'
+require 'specimen/commands/gem_help/gem_help_command'
+require 'specimen/commands/init/init_command'
+require 'specimen/commands/specs/specs_command'
+
+module Specimen
+  module Command
+    class InvalidCommandError < RuntimeError; end
+
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :BaseGroup
+
+    COMMAND_MAPPINGS = %w[cukes exec init specs generate test].to_set
+    HELP_MAPPINGS = %w[-h -? --help].to_set
+    VERSION_MAPPINGS = %w[-v --version].to_set
+
+    class << self
+      attr_reader :args, :config, :exec_config
+
+      def default_config
+        @default_config ||= {
+          verbose: false,
+          strict: false,
+          log_level: :info
+        }
+      end
+
+      def execute!(args = [], config = {})
+        @args = args.dup
+        @config = config
+        @exec_config = default_config.merge!(config)
+
+        trap_interrupt
+
+        raise InvalidCommandError, "'#{command_arg}' is not a valid specimen command!" unless valid_command?
+
+        show_gem_help_and_exit! if gem_help?
+        show_gem_version_and_exit! if show_version?
+        show_command_help_and_exit! if command_help?
+
+        command_perform!
+
+        exit_ok
+      rescue StandardError => e
+        shell.say(e.message.red.bold)
+
+        if exec_config[:verbose]
+          shell.say(e.class.to_s.red.bold)
+          shell.say(e.backtrace&.join("\n").red)
+        end
+
+        exit_specimen_failed
+      end
+
+      def show_gem_help_and_exit!
+        GemHelpCommand.new([]).perform
+
+        exit_ok
+      end
+
+      def show_command_help_and_exit!
+        display_command_help
+
+        exit_ok
+      end
+
+      def show_gem_version_and_exit!
+        shell.say("specimen version: #{Specimen.gem_version.to_s.bold}")
+
+        exit_ok
+      end
+
+      def display_command_help
+        shallow_command.class_usage.nil? ? shallow_command.class.help(shell) : shell.say(shallow_command.class_usage)
+      end
+
+      def command_perform!
+        command.new(command_arguments, parsed_command_options).perform
+      end
+
+      def shallow_command
+        @shallow_command ||= command.new([])
+      end
+
+      def command_arg
+        @command_arg ||= args.first
+      end
+
+      def command_arg?
+        !command_arg.nil?
+      end
+
+      def command_arguments
+        @command_arguments ||= args.reject { |arg| arg == command_arg }
+      end
+
+      def command
+        @command ||= {
+          cukes: CukesCommand,
+          exec: ExecCommand,
+          gem_help: GemHelpCommand,
+          init: InitCommand,
+          specs: SpecsCommand
+        }[command_arg.to_sym]
+      end
+
+      def command_class_options
+        command.class_options
+      end
+
+      def command_local_options
+        @command_local_options ||= {}
+      end
+
+      # need to look into that
+      def command_options_relation
+        {exclusive_option_names: [], at_least_one_option_names: []}
+      end
+
+      def disable_required_check?
+        return true if command_help?
+
+        command.disable_required_check? command
+      end
+
+      def stop_on_unknown_option?
+        exec_config[:strict] || false
+      end
+
+      def parsed_command_options
+        Thor::Options.new(
+          command_class_options,
+          command_local_options,
+          stop_on_unknown_option?,
+          disable_required_check?,
+          command_options_relation
+        ).parse(command_arguments)
+      end
+
+      def command?
+        COMMAND_MAPPINGS.include?(command_arg)
+      end
+
+      def command_help?
+        HELP_MAPPINGS.include?(command_arguments.first)
+      end
+
+      def gem_help?
+        return true if command_arg.nil?
+
+        HELP_MAPPINGS.include?(command_arg)
+      end
+
+      def valid_command?
+        command? || gem_help? || show_version?
+      end
+
+      def show_version?
+        return false if command_arg.nil?
+
+        VERSION_MAPPINGS.include?(command_arg)
+      end
+
+      private
+
+      def shell
+        @shell ||= Thor::Base.shell.new
+      end
+
+      def exit_ok
+        Kernel.exit(0)
+      end
+
+      def exit_specimen_failed
+        Kernel.exit(1)
+      end
+
+      def exit_unable_to_finish
+        Kernel.exit(2)
+      end
+
+      def trap_interrupt
+        Signal.trap('INT') do
+          shell.say("\nExiting... Interrupt again to exit immediately.".red.bold)
+          exit_unable_to_finish
+        end
+      end
+    end
+  end
+end

data/lib/specimen/commands/cukes/cukes_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class CukesCommand < CukesRunner
+      namespace :cukes
+    end
+  end
+end

data/lib/specimen/commands/exec/exec_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class ExecCommand < ExecRunner
+      namespace :exec
+    end
+  end
+end

data/lib/specimen/commands/gem_help/USAGE

@@ -0,0 +1,14 @@
+Usage:
+  specimen COMMAND [options]
+
+You must specify a command:
+
+  init         Initialize a new specimen project
+  cukes        Run Cucumber tests (WIP)
+  specs        Run RSpec tests (WIP)
+  exec         Run tests via a config file (WIP)
+
+  -v|--version Show specimen version
+  -h|--help    You are looking at it
+
+All commands can be run with -h (or --help) for more information.