specimen 0.0.3.alpha → 0.0.4.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c0a28521622f9720868bc538c48567cd6ee1b290dc0939572d0af33d2ef2ecf
-  data.tar.gz: 6d7042ab4f3bd81237694a93ddd7641772a2381597a3185ea258b536616de895
+  metadata.gz: 336dd0051499f6384e21a5963dd70c869103950ddc55e9a832ca88c5de8cdfd2
+  data.tar.gz: 9b76085869efaaf62d49a896b769a58ccce5a5b7c470c437481e8896ab97d389
 SHA512:
-  metadata.gz: 1c53ce47754279e09e849511566fe515d1ed64842653f24beb631a430e77b855249a51a6eee1b7a83b2197be888a8487d97f355028e827e7ac776a87f78aed7f
-  data.tar.gz: aa5615ac6bf581885ae77d4c0321cf0a3473489b25b096684c307817bee0fe406c27bb584aab04a36b7d84bcf236c6a14948b510f7f12c06a9fbb1a5b601bc7a
+  metadata.gz: cfb84ce6b86528fca53e86090d0069bcce2f9efc96d186516d8a6927f4b00ebb9a644e2d664380968e897077b10d4aeeb7db67f173f8a445e20f37bac97f51d6
+  data.tar.gz: fcbb093a73acd7d10ac7fe85160b2346630f132d0c504592b3e5e2f557a25b1e53008da8770cb6080cb7ca6bf1f198b0c9b03d2f5dc5ff2348b3f034a87fb66c

data/README.md

@@ -5,67 +5,72 @@ will help me with:
 
 - setting up a new test automation project, including README, Gemfile, rubocop.yml, etc...
 - run Cucumber and RSpec tests with configs that make sense (e.g. parallel execution, reporting)
-- provide a Rails like templating approach in terms of _convention over configuration_ to provide a maintainable base for
+- 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.
 
+## How to start?
+
+To get familiar with specimen, you can simply create initialize a new project by running the following command.
+
+```shell
+specimen init --name example-project
+```
+
+This will do the following things for you
+
+- create a new directory `/example-project` relative to your current working directory
+- create initial files for running Cucumber or RSpec tests as well as project root files such as a README.md, Gemfile,
+  etc...
+- creates a new encrypted configuration in `/example-project/config/enc/example.yml.enc`
+- creates a new key file in `/example-project/config/enc/example.key` containing the key value to decrypt the
+  configuration which is required when you need to update the encrypted config.
+- creates a .env-file `/example-project/.example.env` containing the `MASTER_KEY` variable and the key value to decrypt
+  the config
+
+Now you can switch to the newly created directory `/example-project` and run e.g. the following commands
+
+```shell
+# run Cucumber tests without additional options
+specimen cukes
+
+# run Cucumber tests tagged with @pass
+specimen cukes -t @pass
+
+# run RSpec tests without additional options
+specimen specs
+
+# run RSpec tests tagged with pass: true
+specimen specs -t pass
+
+# run Cucumber|RSpec tests using the example specimen-profile
+# The 'examples' profile will automatically load and decrypt the 
+# encrypted configuration /config/enc/example.yml.enc during execution.
+specimen cukes|specs --sp|--specimen-profile examples
+```
+
 ## specimen commands
 
 ```shell
-❯ specimen
 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)
+  cukes        Run Cucumber tests
+  specs        Run RSpec tests
+  enc          Create or update encrypted configurations
+
+  -v|--version Show specimen version
+  -h|--help    You are looking at it
 
 All commands can be run with -h (or --help) for more information.
 ```
 
 ### specimen init
 
-```shell
-❯ specimen init -h
-Usage:
-  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:
-  -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
-```
+TBD
 
 ### specimen cukes
 
@@ -75,10 +80,9 @@ TBD
 
 TBD
 
-### specimen exec
-
-TBD
-
 ### Known issues
 
-- tests are missing
+- tests are missing
+- tests do not run in parallel (yet)
+- documentation about allowed options in config-yml´s
+- templates for docker, Selenium, Watir and Playwright

data/VERSION

@@ -1 +1 @@
-0.0.3.alpha
+0.0.4.alpha

data/lib/specimen/command/exec_command_builder.rb

@@ -3,30 +3,60 @@
 module Specimen
   module Command
     class ExecCommandBuilder
-      attr_reader :config
+      VALID_FRAMEWORKS = %w[cucumber rspec]
 
-      def initialize(config:, framework: nil, tests_path: '')
-        @framework = framework
-        @config = config
-        @tests_path = tests_path
+      attr_reader :profile_data, :framework, :command, :runtime
+
+      def self.build_exec_cmd!
+        new.build_cmd
+      end
+
+      def initialize
+        @runtime = Specimen.runtime
+        @profile_data = runtime.profile_data
+        @framework = runtime.framework
+        @command = runtime.command
+        @tests_path = command&.tests_path || ''
       end
 
       def build_cmd
-        raise 'Undefined framework' if base_cmd.nil?
+        raise "Invalid framework '#{framework}'" unless VALID_FRAMEWORKS.include?(framework)
 
-        "#{env_string} #{base_cmd} #{options_string} #{@tests_path}".strip
-      end
+        cmd_str = ''.dup
+        cmd_str << env_string unless env_string.empty?
+        cmd_str << framework.dup.prepend(' ')
+        cmd_str << options_string.prepend(' ') unless options_string.empty?
+        cmd_str << tags_string.prepend(' ') unless tags_string.empty?
+        cmd_str << @tests_path.dup.prepend(' ') unless @tests_path.empty?
 
-      def base_cmd
-        config['framework'] || @framework
+        cmd_str.strip
       end
 
       def env_vars
-        config['env'] || []
+        profile_data['env'] || []
       end
 
       def command_options
-        config['options'] || []
+        profile_data['options'] || []
+      end
+
+      def profile_tags
+        profile_data['tags'] || []
+      end
+
+      def command_tags
+        command&.options[:tags] || []
+      end
+
+      def tags_string
+        str = ''.dup
+        all_tags = profile_tags.concat(command_tags)
+
+        return '' if all_tags.empty?
+
+        # '-t' option works for both Cucumber and RSpec
+        all_tags.each { |tag| str << "-t \"#{tag}\" " }
+        str.rstrip
       end
 
       def env_string

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

@@ -3,24 +3,8 @@
 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
+      class_option :specimen_config, aliases: %w[--sc], type: :string, default: 'specimen.cukes.yml'
+      class_option :specimen_profile, aliases: %w[--sp], type: :string, default: 'cucumber'
     end
   end
 end

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

@@ -3,23 +3,8 @@
 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
+      class_option :specimen_config, aliases: %w[--sc], type: :string, default: 'specimen.specs.yml'
+      class_option :specimen_profile, aliases: %w[--sp], type: :string, default: 'rspec'
     end
   end
 end

data/lib/specimen/command/test_runner.rb

@@ -10,47 +10,41 @@ module Specimen
         end
       end
 
-      class_option :config_file, aliases: %w[-C --config], type: :string, default: 'specimen.yml'
+      class_option :tags, aliases: ['-t'], type: :string, repeatable: true, default: []
+      class_option :debug, type: :boolean, default: false
+      class_option :verbose, type: :boolean, default: false
 
       no_commands do
         def perform
-          runtime
-        end
+          runtime.set_testrunner!(specimen_config, specimen_profile, self)
 
-        def runtime
-          return @runtime if @runtime
+          inside runtime.wd_path do
+            ENV['SPECIMEN_CONFIG_NAME'] = runtime.specimen_config
+            ENV['SPECIMEN_PROFILE_NAME'] = runtime.specimen_profile
 
-          runtime = Runtime.start!(self)
-          Specimen.runtime = runtime
-          @runtime = runtime
-        end
+            ENV['DEBUG'] = 'true' if options[:debug]
+            ENV['VERBOSE'] = 'true' if options[:verbose]
 
-        def framework
-          nil
-        end
+            @success = run(exec_cmd)
+          end
 
-        def profile
-          options[:profile]
+          @success == true ? exit(0) : exit(1)
         end
 
-        def profile?
-          !profile.nil?
+        def runtime
+          Specimen.runtime
         end
 
-        def profile_config
-          runtime.profile_yml_data(profile_name)
+        def specimen_config
+          options[:specimen_config]
         end
 
-        def profile_name
-          profile? ? profile : nil
+        def specimen_profile
+          options[:specimen_profile]
         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?
+          ExecCommandBuilder.build_exec_cmd!
         end
       end
     end

data/lib/specimen/command.rb

@@ -9,11 +9,10 @@ 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/encrypted_configuration/encrypted_configuration_command'
 require 'specimen/commands/gem_help/gem_help_command'
 require 'specimen/commands/init/init_command'
 require 'specimen/commands/specs/specs_command'
@@ -27,7 +26,7 @@ module Specimen
     autoload :Base
     autoload :BaseGroup
 
-    COMMAND_MAPPINGS = %w[cukes exec init specs generate test].to_set
+    COMMAND_MAPPINGS = %w[cukes enc init specs generate].to_set
     HELP_MAPPINGS = %w[-h -? --help].to_set
     VERSION_MAPPINGS = %w[-v --version].to_set
 
@@ -63,7 +62,7 @@ module Specimen
 
         if exec_config[:verbose]
           shell.say(e.class.to_s.red.bold)
-          shell.say(e.backtrace&.join("\n").red)
+          shell.say(e.backtrace.join("\n").red)
         end
 
         exit_specimen_failed
@@ -114,7 +113,7 @@ module Specimen
       def command
         @command ||= {
           cukes: CukesCommand,
-          exec: ExecCommand,
+          enc: EncryptedConfigurationCommand,
           gem_help: GemHelpCommand,
           init: InitCommand,
           specs: SpecsCommand
@@ -178,6 +177,14 @@ module Specimen
         VERSION_MAPPINGS.include?(command_arg)
       end
 
+      def base_command?
+        command.ancestors.include?(Specimen::Command::Base)
+      end
+
+      def base_group_command?
+        command.ancestors.include?(Specimen::Command::BaseGroup)
+      end
+
       private
 
       def shell

data/lib/specimen/commands/encrypted_configuration/USAGE

@@ -0,0 +1,37 @@
+Usage:
+  specimen enc
+
+Commands:
+  specimen enc create          # create a new encrypted configuration
+  specimen enc update          # update an existing encrypted configuration
+  specimen enc validate        # validates if encrypted configuration is YAML conform
+  specimen enc -h|--help       # You are looking at it
+
+Options:
+  -n, [--name=NAME]                       # required: true
+                                          The name of the encrypted config.
+
+                                          Examples:
+
+                                          # create/update/validate config/enc/example.yml.enc
+                                          $ specimen enc create/update/validate --name example
+
+                                          # create/update/validate config/enc/foobar/example.yml.enc
+                                          $ specimen enc create/update/validate --name foobar/example
+
+  -e, [--editor=EDITOR]                   # default: 'vi'
+                                          Is only used with the update command
+
+                                          If you have the variable EDITOR set on your shell, it will override the
+                                          default editor 'vi'
+
+                                          Examples:
+
+                                          # Uses EDITOR variable if set, otherwise 'vi' is used
+                                          $ specimen update --name example
+
+                                          # Uses 'nano' as EDITOR
+                                          $ EDITOR='nano' specimen update --name example
+
+                                          # Uses 'nano' as EDITOR
+                                          $ specimen update --name example --editor nano

data/lib/specimen/commands/encrypted_configuration/encrypted_configuration_command.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'specimen/utils'
+
+module Specimen
+  module Command
+    class EncryptedConfigurationCommand < Base
+      class RequiredOptionError < StandardError
+        def initialize
+          @msg = "Please provide required option '--name'!"
+          super(@msg)
+        end
+      end
+
+      class OptionNameError < StandardError
+        def initialize
+          @msg = "Option '--name' can not be empty or equal 'name'!"
+          super(@msg)
+        end
+      end
+
+      class ExistingConfigFilesError < StandardError; end
+      class NoSuchConfigError < StandardError; end
+      class MissingKeyFileError < StandardError; end
+
+      include Utils
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      class_option :name, aliases: %w[-n], type: :string
+      class_option :editor, aliases: %w[-e], type: :string, default: 'vi'
+
+      desc 'create', 'create'
+
+      def create
+        encrypted_config = EncryptedConfiguration.create(name:)
+
+        say(gen_message(encrypted_config).green.bold)
+        say("\n  NEVER COMMIT/PUBLISH '*.key' files to your repository !!!\n".bold)
+      end
+
+      desc 'update', 'update'
+
+      def update
+        ENV['EDITOR'] = ENV.fetch('EDITOR', options[:editor])
+        EncryptedConfiguration.update(name:)
+
+        say("Updated encrypted config '#{name}.yml.enc'".green)
+      end
+
+      desc 'validate', 'validate'
+
+      def validate
+        result = EncryptedConfiguration.validate(name:)
+
+        say("Config '#{name}.yml.enc' validated and ready to use".green) if result.is_a?(EncryptedConfigPath)
+        return if result.is_a?(EncryptedConfigPath)
+
+        say("#{result.class}\n #{result.message}".red)
+        say('Please fix the yml syntax errors before you proceed'.bold)
+      end
+
+      no_commands do
+        def perform
+          run_args_check!
+          run_options_checks!
+
+          send(task_arg)
+        end
+
+        def name
+          options[:name]
+        end
+
+        def task_arg
+          args.first
+        end
+
+        def task?
+          respond_to?(task_arg)
+        end
+
+        def run_args_check!
+          return if task?
+
+          raise "No such command: '#{task_arg}'. Either use 'specimen enc create' or 'specimen enc update'"
+        end
+
+        def run_options_checks!
+          raise RequiredOptionError if options[:name].nil?
+          raise RequiredOptionError if options[:name].empty?
+          raise OptionNameError if options[:name] == 'name'
+        end
+
+        def gen_message(enc_path)
+          <<~STRING
+            Generated new encrypted configuration: '#{enc_path.name}.yml.enc'
+
+              encrypted-config-path: #{enc_path.full_enc_path.to_path}
+              encryption-key-path: #{enc_path.full_key_path.to_path}
+          STRING
+        end
+      end
+    end
+  end
+end

data/lib/specimen/commands/gem_help/USAGE

@@ -4,9 +4,9 @@ Usage:
 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)
+  cukes        Run Cucumber tests
+  specs        Run RSpec tests
+  enc          Create or update encrypted configurations
 
   -v|--version Show specimen version
   -h|--help    You are looking at it

data/lib/specimen/config_parser.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Specimen
+  class ConfigParser
+    class YmlERBError < StandardError; end
+
+    def self.read!(file)
+      new(file).yml_load!
+    end
+
+    def initialize(file)
+      @file = file
+    end
+
+    def yml_load!
+      YAML.safe_load(erb_content, aliases: true)
+    end
+
+    private
+
+    def content
+      File.read(@file)
+    end
+
+    def erb_content
+      ERB.new(content, trim_mode: '%').result(binding)
+    rescue StandardError
+      raise YmlERBError, "#{@file} could not be parsed with ERB!"
+    end
+  end
+end

data/lib/specimen/generator/configs/specimen_project_config.rb

@@ -35,7 +35,7 @@ module Specimen
       def config
         @config ||= {
           project_name: project_name,
-          root_path: "#{Specimen.init_wd_path.to_path}/#{project_name}",
+          root_path: "#{Specimen.runtime.wd_path.to_path}/#{project_name}",
           gems: project_gems,
           skip_ui: skip_ui?,
           cucumber: !skip_cucumber?,

data/lib/specimen/generator/cucumber/cucumber_project_generator.rb

@@ -7,8 +7,10 @@ module Specimen
       TEMPLATES_DIR = 'cucumber/templates'
       TEMPLATES = %w[
         features/examples/add_numbers.feature
+        features/step_definitions/examples/example_steps.rb
         features/support/env.rb
         config/cucumber.yml
+        config/specimen.cukes.yml
       ].freeze
 
       def execute!

data/lib/specimen/generator/cucumber/templates/config/cucumber.yml.tt

@@ -1 +1,4 @@
-default: --require features/support/env.rb
+default: --profile entry_point --profile step_definitions
+
+entry_point: --require features/support/env.rb
+step_definitions: --require features/step_definitions

data/lib/specimen/generator/cucumber/templates/config/specimen.cukes.yml.tt

@@ -0,0 +1,22 @@
+default_opts: &default_opts
+  - --publish-quiet
+  - --format pretty
+  - --format html --out tmp/cucumber_result.html
+
+cucumber: &cucumber
+  profiles: []
+  options: *default_opts
+
+examples:
+  <<: *cucumber
+  env_file: .example.env
+  enc_configs:
+    - name: example
+      env_key: MASTER_KEY
+
+ci_cukes:
+  <<: *cucumber
+  env:
+    - CI='1'
+  profiles:
+    - regression

data/lib/specimen/generator/cucumber/templates/features/examples/add_numbers.feature.tt

@@ -1,9 +1,11 @@
 Feature: Add numbers example feature
 
+  @pass
   Scenario:
     Given I add 1 and 1
     Then the result should be 2
 
+  @fail
   Scenario:
-    Given I add 1 and 3
-    Then the result should be 3
+    Given I add 1 and 1
+    Then the result should be 3

data/lib/specimen/generator/cucumber/templates/features/step_definitions/examples/example_steps.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Given('I add {int} and {int}') do |int, int2|
+  @result = int + int2
+end
+
+Then('the result should be {int}') do |int|
+  expect(@result).to eq int
+end