specimen 0.0.3.alpha → 0.0.4.alpha

data/lib/specimen/generator/cucumber/templates/features/support/env.rb.tt

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+lib_path = "#{File.expand_path(__dir__)}/lib"
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'pry' if ENV.key?('DEBUG')
+require 'specimen'
+require 'rspec'
+
+World RSpec::Expectations, RSpec::Matchers
+
+BeforeAll do
+  Specimen.run_testrunner_hooks!
+end
+
+Before do
+  @enc_config = Specimen.enc_config
+end
+
+at_exit do
+  p 'bye bye'
+end

data/lib/specimen/generator/project/project_root_generator.rb

@@ -11,7 +11,6 @@ module Specimen
         .rubocop.yml
         Gemfile
         README.md
-        config/specimen.yml
       ].freeze
 
       def execute!

data/lib/specimen/generator/project/specimen_project_generator.rb

@@ -13,12 +13,49 @@ module Specimen
           CucumberProjectGenerator.start([config]) if config[:cucumber]
           RSpecProjectGenerator.start([config]) if config[:rspec]
 
+          inside config[:root_path] do
+            run('specimen enc create --name example')
+
+            env_file = '.example.env'
+            enc_key = File.read "#{Dir.pwd}/config/enc/example.key"
+            content = "MASTER_KEY='#{enc_key}'\n"
+            File.write(env_file, content)
+
+            say("Created env-file '#{env_file}' containing the MASTER_KEY to decrypt config/enc/example.yml.enc".bold)
+          end
+
+          say(init_message.green.bold)
           true
         end
 
         def config
           @config ||= Generator::SpecimenProjectConfig.parse(options)
         end
+
+        def init_message
+          enc_config = 'config/enc/example.yml.enc'
+
+          <<~STRING
+
+            Created new specimen project in 
+            #{config[:root_path]}
+
+            Please cd into the directory and run e.g.
+
+            # check out the help for cukes and specs command 
+            $> specimen cukes|specs --help|-h 
+
+            # run tests using the encrypted example configuration
+            $> specimen cukes|specs --specimen-profile|--sp examples
+
+            # Check out the 'enc' command help
+            $> specimen enc --help|-h
+
+            # Read and update the encrypted config '#{enc_config}'
+            $> specimen enc update --name|-n example
+
+          STRING
+        end
       end
     end
   end

data/lib/specimen/generator/project/templates/root/config/specimen.yml.tt

@@ -3,6 +3,7 @@ default: &default
   env:
     - FOO='123'
 
+<% if data[:cucumber] -%>
 cucumber: &cucumber
   framework: cucumber
   profiles: []
@@ -14,6 +15,15 @@ cucumber: &cucumber
     - FOO='123'
     - BAZ='something'
 
+ci_cukes:
+  <<: *cucumber
+  env:
+    - CI='1'
+  profiles:
+    - regression
+<% end -%>
+
+<% if data[:rspec] -%>
 rspec: &rspec
   framework: rspec
   options:
@@ -29,10 +39,4 @@ ci_specs:
   <<: *rspec
   env:
     - CI='1'
-
-ci_cukes:
-  <<: *cucumber
-  env:
-    - CI='1'
-  profiles:
-    - regression
+<% end -%>

data/lib/specimen/generator/rspec/rspec_project_generator.rb

@@ -9,6 +9,7 @@ module Specimen
         spec/examples/example_spec.rb
         spec/spec_helper.rb
         config/.rspec
+        config/specimen.specs.yml
       ].freeze
 
       def execute!

data/lib/specimen/generator/rspec/templates/config/.rspec.tt

@@ -1,5 +1 @@
 --require ./spec/spec_helper
-
---format progress
---format documentation
---format html --out tmp/rspec_result.html

data/lib/specimen/generator/rspec/templates/config/specimen.specs.yml.tt

@@ -0,0 +1,19 @@
+default_opts: &default_opts
+  - --options config/.rspec
+  - --format documentation
+  - --format html --out tmp/rspec_result.html
+
+rspec: &rspec
+  options: *default_opts
+
+examples:
+  <<: *rspec
+  env_file: .example.env
+  enc_configs:
+    - name: example
+      env_key: MASTER_KEY
+
+ci_specs:
+  <<: *rspec
+  env:
+    - CI='1'

data/lib/specimen/generator/rspec/templates/spec/examples/example_spec.rb.tt

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
-RSpec.describe 'Example specs' do
-  context 'run example tests' do
+RSpec.describe 'Add numbers specs' do
+  context 'add 1 + 1', add_numbers: true do
     before(:example) do
-      @foo = '123'
+      @result = 1 + 1
     end
 
-    it 'passes' do
-      expect(@foo).to eq '123'
+    it 'passes', pass: true do
+      expect(@result).to eq 2
+    end
+
+    it 'fails due to not being an integer', fail: true do
+      expect(@result).to eq '2'
     end
   end
 end

data/lib/specimen/generator/rspec/templates/spec/spec_helper.rb.tt

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-# require rubygems
-require 'pry'
+require 'specimen'
 
 RSpec.configure do |config|
-  # generic base config for each example
-  config.before(:example) do
-    p 'always running'
+  config.before(:suite) do
+    Specimen.run_testrunner_hooks!
+  end
+
+  config.before(:all) do
+    @enc_config = Specimen.enc_config
   end
 end
 

data/lib/specimen/runtime.rb

@@ -1,84 +1,154 @@
 # frozen_string_literal: true
 
-require_relative 'runtime/yml_parser'
+require 'dotenv'
+require 'specimen/config_parser'
 
 module Specimen
-  module Runtime
-    class MissingCommandOptionError < RuntimeError
-      def initialize(command, option)
-        @msg = "Command '#{command}' misses option: '#{option}'"
-        super(@msg)
-      end
+  class Runtime
+    class ConfigNotFoundError < RuntimeError; end
+    class ProfileNotFoundError < RuntimeError; end
+
+    attr_reader :wd_path, :config_directory,
+                :program_name, :config_data,
+                :profile_data, :framework
+
+    attr_accessor :command, :specimen_config, :specimen_profile
+
+    def initialize
+      @wd_path = Pathname.getwd
+      @config_directory = Pathname.new("#{wd_path}/config")
+      @program_name = $PROGRAM_NAME
+      @command = nil
+      @specimen_config = nil
+      @specimen_profile = nil
+      @config_data = nil
+      @profile_data = nil
     end
 
-    class UndefinedYmlError < RuntimeError
-      def initialize
-        @msg = "Option '--config-fie' is not set!"
-        super(@msg)
-      end
+    def set_testrunner!(config, profile, command)
+      @specimen_config = config
+      @specimen_profile = profile
+      @command = command
+
+      define_framework!
+      run_default_profile_checks!
+
+      load_specimen_config!
+      load_specimen_profile!
     end
 
-    class YmlNotFoundError < RuntimeError
-      def initialize(yml_path)
-        @msg = "No such file: '#{yml_path.to_path}'"
-        super(@msg)
-      end
+    def run_load_profile_hook!
+      @specimen_config = ENV.fetch('SPECIMEN_CONFIG_NAME')
+      @specimen_profile = ENV.fetch('SPECIMEN_PROFILE_NAME')
+
+      load_specimen_config!
+      load_specimen_profile!
     end
 
-    DEFAULT_YML_NAME = 'specimen.yml'
+    def run_env_file_hook!
+      return unless profile_with_env_file?
 
-    class << self
-      attr_reader :command, :config
+      file = profile_data['env_file']
+      path = Pathname.new("#{wd_path}/#{file}")
 
-      def start!(command, **config)
-        @command = command
-        @config = config
+      return Dotenv.load!(path.to_path) if path.exist?
 
-        return if skip_yml_load?
-        raise YmlNotFoundError, yml_path unless yml_path.exist?
+      raise "Environment file: '#{path.to_path}' is defined in profile '#{specimen_profile}' but it does not exist!"
+    end
 
-        self
-      end
+    def run_decrypt_enc_configs_hook!
+      return unless profile_with_enc_configs?
 
-      def work_dir
-        @work_dir ||= Pathname.getwd
-      end
+      encrypted_config = {}
+      enc_configs = profile_data['enc_configs']
 
-      def config_dir
-        @config_dir ||= Pathname.new("#{work_dir}/config")
-      end
+      enc_configs.each do |enc_config|
+        name = enc_config['name']
+        env_key = enc_config['env_key']
 
-      def yml_path
-        @yml_path ||= Pathname.new("#{config_dir}/#{yml_name}")
-      end
+        warn "env key '#{env_key}' defined but not set!" if env_key && !ENV.key?(env_key)
+        env_key.nil? ? env_key = '' : env_key
 
-      def skip_yml_load?
-        command.is_a?(Command::InitCommand)
+        config = Specimen::Utils::EncryptedConfiguration.decrypt(name:, env_key:)
+        encrypted_config.merge!(config)
       end
 
-      def yml_name
-        return @yml_name if @yml_name
+      Specimen.enc_config = encrypted_config
+    end
 
-        key_name = 'config_file'
-        raise MissingCommandOptionError, command, key_name unless command.options.key?(key_name)
+    def define_framework!
+      raise 'Unrecognized command' unless cukes? || specs?
 
-        yml_name = command.options[key_name]
-        raise UndefinedYmlError if yml_name.empty?
+      @framework = cukes? ? 'cucumber' : 'rspec'
+    end
 
-        @yml_name = yml_name
-      end
+    def run_default_profile_checks!
+      raise 'You can not use the rspec profile with Cucumber!' if cukes? && specimen_profile == 'rspec'
+      raise 'You can not use the cucumber profile with RSpec!' if specs? && specimen_profile == 'cucumber'
+    end
 
-      def yml_data
-        @yml_data ||= YmlParser.parse!(yml_path.to_path)
-      end
+    def load_specimen_profile!
+      raise 'Specimen profile is not set!' if specimen_profile.nil? || specimen_profile.empty?
 
-      def default_yml_data
-        @default_yml_data ||= profile_yml_data('default')
+      unless config_data&.key?(specimen_profile)
+        raise ProfileNotFoundError, "Can not find profile '#{specimen_profile}' in #{specimen_config_path.to_path}"
       end
 
-      def profile_yml_data(profile = nil)
-        yml_data[profile]
-      end
+      @profile_data = config_data[specimen_profile]
+    end
+
+    def load_specimen_config!
+      raise ConfigNotFoundError, 'Specimen config not found' unless specimen_config_exist?
+
+      @config_data = ConfigParser.read!(specimen_config_path.to_path)
+    end
+
+    def specimen_config_path
+      Pathname.new("#{config_directory}/#{specimen_config}")
+    end
+
+    def custom_config
+      @specimen_config
+    end
+
+    def profile_with_enc_configs?
+      return false unless profile_data.is_a?(Hash)
+
+      profile_data&.key?('enc_configs')
+    end
+
+    def profile_with_env_file?
+      return false unless profile_data.is_a?(Hash)
+
+      profile_data&.key?('env_file')
+    end
+
+    def cukes?
+      return false if command.nil?
+
+      command.is_a?(Command::CukesCommand)
+    end
+
+    def specs?
+      return false if command.nil?
+
+      command.is_a?(Command::SpecsCommand)
+    end
+
+    def specimen_config_exist?
+      specimen_config_path.exist?
+    end
+
+    def specimen_bin?
+      program_name.include?('bin/specimen')
+    end
+
+    def cucumber_bin?
+      program_name.include?('bin/cucumber')
+    end
+
+    def parallel_cucumber_bin?
+      program_name.include?('bin/parallel_cucumber')
     end
   end
 end

data/lib/specimen/utils/encrypted_config_path.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Utils
+    class EncryptedConfigPath
+      ENC_DIRECTORY = 'config/enc'
+
+      attr_reader :name, :runtime
+
+      def initialize(name:)
+        @name = name
+        @runtime = Specimen.runtime
+      end
+
+      def config_base_dir
+        @config_base_dir ||= Pathname.new("#{runtime.wd_path}/#{ENC_DIRECTORY}")
+      end
+
+      def enc_dir
+        return Pathname.new(config_base_dir.to_path) if config_dir.empty?
+
+        Pathname.new("#{config_base_dir}/#{config_dir}")
+      end
+
+      def config_file_name
+        "#{split_name.last}.yml.enc"
+      end
+
+      def config_dir
+        split_name[0...-1].join('/')
+      end
+
+      def split_name
+        name.split('/')
+      end
+
+      def full_enc_path
+        @full_enc_path ||= Pathname.new("#{enc_dir}/#{config_file_name}")
+      end
+
+      def full_key_path
+        @full_key_path ||= Pathname.new("#{enc_dir}/#{config_file_name.gsub('.yml.enc', '.key')}")
+      end
+
+      def config_exist?
+        full_enc_path.exist?
+      end
+
+      def key_exist?
+        full_key_path.exist?
+      end
+    end
+  end
+end

data/lib/specimen/utils/encrypted_configuration.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'active_support/encrypted_configuration'
+require 'specimen/utils/encrypted_config_path'
+
+module Specimen
+  module Utils
+    class EncryptedConfiguration
+      class ExistingConfigFilesError < StandardError; end
+      class NoSuchConfigError < StandardError; end
+      class MissingKeyFileError < StandardError; end
+      class MissingKeyFileError < StandardError; end
+
+      attr_accessor :name
+      attr_reader :enc_path, :env_key, :config_path, :key_path
+
+      def self.create(name:)
+        new(name:).create_encrypted_config!
+      end
+
+      def self.update(name:)
+        new(name:).update_encrypted_config!
+      end
+
+      def self.validate(name:)
+        new(name:).validate_encrypted_config!
+      end
+
+      def self.decrypt(name:, env_key: 'MASTER_KEY')
+        new(name:, env_key:).decrypt_config!
+      end
+
+      def initialize(name:, env_key: '')
+        @name = name
+        @enc_path = EncryptedConfigPath.new(name:)
+        @config_path = @enc_path.full_enc_path
+        @key_path = @enc_path.full_key_path
+        @env_key = env_key
+      end
+
+      def decrypt_config!
+        raise NoSuchConfigError, "No such file: '#{config_path.to_path}'" unless config_exist?
+        raise "Missing decryption key for enc-config '#{enc_path.name}'" unless decryption_key?
+
+        YAML.load(enc_yml_content).deep_symbolize_keys!
+      end
+
+      def validate_encrypted_config!
+        run_enc_files_check!
+        YAML.load(enc_yml_content)
+        enc_path
+      rescue StandardError => e
+        e
+      end
+
+      def enc_yml_content
+        enc_config.read
+      end
+
+      def decryption_key?
+        key_exist? || env_key_set?
+      end
+
+      def env_key_set?
+        return false if env_key.empty?
+
+        ENV.key?(env_key)
+      end
+
+      def run_enc_files_check!
+        raise NoSuchConfigError, "No such file: '#{config_path.to_path}'" unless config_exist?
+        raise MissingKeyFileError, "Missing encryption key file: '#{key_path.to_path}'" unless key_exist?
+      end
+
+      def update_encrypted_config!
+        raise NoSuchConfigError, "No such file: '#{config_path.to_path}'" unless config_exist?
+        raise MissingKeyFileError, "Missing encryption key file: '#{key_path.to_path}'" unless key_exist?
+        raise 'Missing EDITOR variable' unless editor_set?
+        raise "Can not find executable for editor '#{editor}'" unless editor?
+
+        enc_config.change do |tmp_path|
+          system("#{ENV.fetch('EDITOR')} #{tmp_path}")
+        end
+      end
+
+      def create_encrypted_config!
+        raise ExistingConfigFilesError, "Existing config at #{config_path.to_path}" if config_exist?
+        raise ExistingConfigFilesError, "Existing key file at #{key_path.to_path}" if key_exist?
+
+        create_key_file!
+        create_enc_config!
+
+        enc_path
+      end
+
+      def enc_config
+        @enc_config ||= ActiveSupport::EncryptedConfiguration.new(
+          config_path:,
+          key_path:,
+          env_key:,
+          raise_if_missing_key: true
+        )
+      end
+
+      def config_exist?
+        enc_path.config_exist?
+      end
+
+      def key_exist?
+        enc_path.key_exist?
+      end
+
+      def create_key_file!
+        FileUtils.mkdir_p(key_path.dirname) unless key_path.directory?
+        key_path.write(generate_key)
+      end
+
+      def create_enc_config!
+        enc_config.write(example_yml)
+      end
+
+      def generate_key
+        ActiveSupport::EncryptedFile.generate_key
+      end
+
+      def editor
+        ENV.fetch('EDITOR')
+      end
+
+      def editor_set?
+        ENV.fetch('EDITOR', false)
+      end
+
+      def editor?
+        system("command -v #{editor}")
+      end
+
+      def example_yml
+        <<~YML
+          user:
+            email: john.doe@example.com
+            password: johnspassword
+
+          service:
+            host: https://api.my-website.biz
+            client_id: secret-id
+            client_secret: client-secret
+
+          platform:
+            website_url: https://my-website.biz
+            admin_url: https://admin.my-website.biz
+        YML
+      end
+    end
+  end
+end

data/lib/specimen/utils.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'utils/encrypted_configuration'
+
+module Specimen
+  module Utils
+  end
+end

data/lib/specimen/version.rb

@@ -8,7 +8,7 @@ module Specimen
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
     PRE   = 'alpha'
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/specimen.rb

@@ -13,13 +13,21 @@ require 'specimen/runtime'
 require 'specimen/version'
 
 module Specimen
-  extend ActiveSupport::Autoload
-
   class << self
-    attr_accessor :runtime
+    attr_accessor :enc_config
+
+    def runtime
+      @runtime ||= Specimen::Runtime.new
+    end
+
+    def run_testrunner_hooks!
+      runtime.run_load_profile_hook!
+      runtime.run_env_file_hook!
+      runtime.run_decrypt_enc_configs_hook!
+    end
 
-    def init_wd_path
-      @init_wd_path ||= Pathname.getwd
+    def shell
+      runtime&.command.shell
     end
   end
 end