omnitest-psychic 0.0.9

data/lib/omnitest/psychic/factories/powershell_factories.rb

@@ -0,0 +1,53 @@
+module Omnitest
+  class Psychic
+    module Factories
+      class PowerShellTaskFactory < MagicTaskFactory
+        TASK_PRIORITY = 1
+        EXTENSIONS = ['.ps1']
+        magic_file 'scripts/*.ps1'
+        register_task_factory
+
+        def initialize(psychic, opts = {})
+          super
+          @known_tasks = Dir["#{cwd}/scripts/*"].map do | script |
+            File.basename(script, File.extname(script)) if EXTENSIONS.include?(File.extname(script))
+          end
+        end
+
+        def task(task_alias)
+          task = task_alias.to_s
+          script = Dir["#{cwd}/scripts/#{task}{.ps1}"].first
+          relativize_cmd(script) if script
+        end
+
+        def active?
+          true if psychic.os_family == :windows
+        end
+
+        private
+
+        def relativize_cmd(cmd)
+          cmd = Omnitest::Core::FileSystem.relativize(cmd, cwd)
+          "PowerShell -NoProfile -ExecutionPolicy Bypass -File \"#{cmd}\""
+        end
+      end
+
+      class PowerShellScriptFactory < ScriptFactory
+        runs '**.ps1', 5
+
+        def active?
+          true if psychic.os_family == :windows
+        end
+
+        def script(script)
+          script = psychic.task('run_script')
+          if script
+            "#{script} #{script.source_file}"
+          else
+            relativize_cmd(script.absolute_source_file)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/psychic/factories/ruby_factories.rb

@@ -0,0 +1,56 @@
+module Omnitest
+  class Psychic
+    module Factories
+      module UsesBundler
+        def bundle_command
+          bundler_active? ? 'bundle exec ' : ''
+        end
+
+        protected
+
+        def bundler_active?
+          psychic.task_factory_manager.active? BundlerTaskFactory
+        end
+      end
+
+      class BundlerTaskFactory < MagicTaskFactory
+        TASK_PRIORITY = 2
+        magic_file 'Gemfile'
+        magic_file '.bundle/config'
+        magic_env_var 'BUNDLE_GEMFILE'
+        register_task_factory
+
+        def active?
+          # Avoid detecting omnitest's own BUNDLE_GEMFILE variable
+          Bundler.with_clean_env do
+            super
+          end
+        end
+
+        task :bootstrap do
+          'bundle install'
+        end
+      end
+
+      class RakeFactory < MagicTaskFactory
+        include UsesBundler
+        magic_file 'Rakefile'
+        register_task_factory
+
+        task :test do
+          [bundle_command, 'rake'].join
+        end
+      end
+
+      class RubyFactory < ScriptFactory
+        include UsesBundler
+        register_script_factory
+        runs '**.rb', 8
+
+        def script(script)
+          [bundle_command, "ruby #{script.source_file}"].join
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/psychic/factories/shell_factories.rb

@@ -0,0 +1,89 @@
+module Omnitest
+  class Psychic
+    module Factories
+      module ShellBase
+        EXTENSIONS = ['.sh', '']
+
+        def active?
+          true unless psychic.os_family == :windows
+        end
+
+        protected
+
+        def relativize_cmd(cmd)
+          cmd = Omnitest::Core::FileSystem.relativize(cmd, cwd)
+          "./#{cmd}" unless cmd.to_s.start_with? '/'
+        end
+      end
+
+      class ShellTaskFactory < MagicTaskFactory
+        include ShellBase
+        TASK_PRIORITY = 1
+        magic_file '{script,scripts}/*'
+        register_task_factory
+
+        def initialize(*args)
+          super
+          @known_tasks = Dir.glob("#{cwd}/{script,scripts}/*", File::FNM_CASEFOLD).map do | script |
+            File.basename(script, File.extname(script)) if EXTENSIONS.include?(File.extname(script))
+          end
+        end
+
+        def task(task_alias)
+          task = task_alias.to_s
+          script = Dir.glob("#{cwd}/{script,scripts}/#{task}{.sh,}", File::FNM_CASEFOLD).first
+          relativize_cmd(script) if script
+        end
+      end
+
+      class ShellScriptFactory < ScriptFactory
+        include ShellBase
+        register_script_factory
+        runs '**.sh', 5
+
+        def shell_task_factory
+          psychic.task_factory_manager.active? ShellTaskFactory
+        end
+
+        def priority_for_script(script)
+          return 8 if shell_task_factory.known_task? :run_script
+
+          case script.extname
+          when '.sh'
+            9
+          when ''
+            7
+          else
+            5 if shebang?(script)
+          end
+        end
+
+        def script(script)
+          base_command = run_script_command
+          if base_command
+            "#{base_command} #{script.source_file}"
+          else
+            relativize_cmd(script.absolute_source_file)
+          end
+        end
+
+        protected
+
+        def run_script_command
+          psychic.task('run_script')
+        rescue TaskNotImplementedError
+          nil
+        end
+
+        def shebang?(script)
+          first_line = script.source.lines.first
+          first_line && first_line.match(/\#\!/)
+        rescue => e
+          logger.warn("Could not read #{script.source_file}: #{e.message}")
+          # Could be binary, unknown encoding, ...
+          false
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/psychic/factories/travis_factories.rb

@@ -0,0 +1,33 @@
+module Omnitest
+  class Psychic
+    module Factories
+      class TravisTaskFactory < MagicTaskFactory
+        TASK_PRIORITY = 2
+        magic_file '.travis.yml'
+        register_task_factory
+
+        def active?
+          super && travis_allowed? && travis_build_installed?
+        end
+
+        def travis_allowed?
+          psychic.opts[:travis]
+        end
+
+        def travis_build_installed?
+          # check that the travis-build extension is installed
+          # HACK: use the MixlibShellOutExecutor
+          Bundler.with_clean_env { `travis help --skip-version-check`.match(/run/) }
+        end
+
+        task :bootstrap do
+          psychic.execute('travis run --print --skip-version-check install').stdout
+        end
+
+        task :unittest do
+          psychic.execute('travis run --print --skip-version-check script').stdout
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/psychic/factory_manager.rb

@@ -0,0 +1,46 @@
+module Omnitest
+  class Psychic
+    class FactoryManager
+      include Omnitest::Core::Logger
+
+      BUILT_IN_DIR = File.expand_path('../factories', __FILE__)
+
+      class << self
+        def autoload_factories!
+          # Load built-in task factories
+          Dir.glob("#{BUILT_IN_DIR}/*.rb", File::FNM_CASEFOLD).each do |task_factory_file|
+            require task_factory_file
+          end
+        end
+
+        def factory_classes
+          @factory_classes ||= Set.new
+        end
+
+        def register_factory(klass)
+          factory_classes.add klass
+        end
+
+        def clear
+          factory_classes.clear
+        end
+      end
+
+      attr_reader :factories
+
+      def initialize(*args)
+        @factories = self.class.factory_classes.map { |k| k.new(*args) }
+      end
+
+      def active_factories
+        factories.select(&:active?).sort_by(&:priority)
+      end
+
+      def active?(klass)
+        factories.find do | factory |
+          factory.is_a? klass
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/psychic/file_finder.rb

@@ -0,0 +1,69 @@
+module Omnitest
+  class Psychic
+    class FileFinder
+      attr_reader :search_path, :ignored_patterns
+
+      def initialize(search_path, ignored_patterns)
+        @search_path = search_path
+        @ignored_patterns = ignored_patterns || read_gitignore(search_path)
+      end
+
+      # Finds a file by loosely matching the file name to a scenario name
+      def find_file(name)
+        return name if File.exist? File.expand_path(name, search_path)
+
+        # Filter out ignored files
+        files = potential_files(name).select do |f|
+          !ignored?(f)
+        end
+
+        if block_given?
+          file = yield files
+        else
+          # Select the shortest path, likely the best match
+          file = files.min_by(&:length)
+        end
+
+        fail Errno::ENOENT, "No file was found for #{name} within #{search_path}" if file.nil?
+        Omnitest::Core::FileSystem.relativize(file, search_path)
+      end
+
+      def potential_files(name)
+        slugified_name = Omnitest::Core::FileSystem.slugify(name)
+        glob_string = "#{search_path}/**/*#{slugified_name}*.*"
+        potential_files = Dir.glob(glob_string, File::FNM_CASEFOLD)
+        potential_files.concat Dir.glob(glob_string.gsub('_', '-'), File::FNM_CASEFOLD)
+        potential_files.concat Dir.glob(glob_string.gsub('_', ''), File::FNM_CASEFOLD)
+      end
+
+      private
+
+      # @api private
+      def read_gitignore(dir)
+        gitignore_file = "#{dir}/.gitignore"
+        File.read(gitignore_file)
+      rescue
+        ''
+      end
+
+      # @api private
+      def ignored?(target_file)
+        # Trying to match the git ignore rules but there's some discrepencies.
+        ignored_patterns.split.find do |pattern|
+          # if git ignores a folder, we should ignore all files it contains
+          pattern = "#{pattern}**" if pattern[-1] == '/'
+          started_with_slash = pattern.start_with? '/'
+
+          pattern.gsub!(%r{\A/}, '') # remove leading slashes since we're searching from root
+          file = Omnitest::Core::FileSystem.relativize(target_file, search_path)
+          ignored = file.fnmatch? pattern
+          ignored || (file.fnmatch? "**/#{pattern}" unless started_with_slash)
+        end
+      end
+
+      def self.find_file_by_alias(file_alias, search_path, ignored_patterns = nil, &block)
+        FileFinder.new(search_path, ignored_patterns).find_file(file_alias, &block)
+      end
+    end
+  end
+end

data/lib/omnitest/psychic/hints.rb

@@ -0,0 +1,21 @@
+module Omnitest
+  class Psychic
+    class Hints < Omnitest::Core::Dash
+      field :options, Hash, default: {}
+      field :tasks, Hash[String => String]
+      field :scripts, Hash[String => Pathname]
+
+      def options
+        self[:options] ||= {}
+      end
+
+      def tasks
+        self[:tasks] ||= {}
+      end
+
+      def scripts
+        self[:scripts] ||= {}
+      end
+    end
+  end
+end

data/lib/omnitest/psychic/magic_task_factory.rb

@@ -0,0 +1,98 @@
+module Omnitest
+  class Psychic
+    class MagicTaskFactory
+      include Omnitest::Core::Logger
+      extend Forwardable
+      def_delegators :psychic, :cwd, :env, :logger
+
+      TASK_PRIORITY = 5
+
+      attr_reader :known_tasks, :tasks, :hints, :priority, :psychic
+
+      class << self
+        def register_task_factory
+          Omnitest::Psychic::TaskFactoryManager.register_factory(self)
+        end
+
+        def magic_file_patterns
+          @magic_file_patterns ||= []
+        end
+
+        def magic_file(pattern) # rubocop:disable Style/TrivialAccessors
+          magic_file_patterns << pattern
+        end
+
+        def magic_env_vars
+          @magic_env_vars ||= []
+        end
+
+        def magic_env_var(var)
+          magic_env_vars << var
+        end
+
+        def known_tasks
+          @known_tasks ||= []
+        end
+
+        def tasks
+          @tasks ||= {}
+        end
+
+        def task(name, &block)
+          name = name.to_s
+          tasks[name] = block
+          known_tasks << name
+        end
+      end
+
+      def initialize(psychic, opts = {})
+        @psychic = psychic
+        @opts = opts
+        @priority = self.class::TASK_PRIORITY
+        init_attr(:known_tasks) { self.class.known_tasks }
+        init_attr(:tasks) { self.class.tasks }
+      end
+
+      def task(task_alias, *_args)
+        task_alias = task_alias.to_s
+        task = tasks[task_alias] if tasks.include? task_alias
+        task = instance_eval(&task) if task.respond_to? :call
+        fail Omnitest::Psychic::TaskNotImplementedError, task_alias if task.nil?
+        task
+      end
+
+      def active?
+        self.class.magic_file_patterns.each do | pattern |
+          return true unless Dir.glob("#{cwd}/#{pattern}", File::FNM_CASEFOLD).empty?
+        end
+        self.class.magic_env_vars.each do | var |
+          return true if ENV[var]
+        end
+        false
+      end
+
+      def known_task?(task_alias)
+        known_tasks.include?(task_alias.to_s)
+      end
+
+      def priority_for_task(task_alias)
+        priority if known_task? task_alias
+      end
+
+      private
+
+      def init_attr(var)
+        var_name = "@#{var}"
+        var_value = @opts[var]
+        var_value = yield if var_value.nil? && block_given?
+        instance_variable_set(var_name, var_value)
+      end
+
+      def init_attrs(*vars)
+        vars.each do | var |
+          init_attr var
+        end
+      end
+    end
+  end
+end