omnitest 0.2.1

data/lib/omnitest/cli.rb

@@ -0,0 +1,297 @@
+require 'thor'
+
+require 'omnitest'
+require 'omnitest/command'
+require 'omnitest/command/generate'
+require 'omnitest/psychic/cli'
+require 'omnitest/skeptic/cli'
+
+module Omnitest
+  module Command
+    class Generate
+      autoload :Dashboard, 'omnitest/command/generators/dashboard'
+      autoload :Code2Doc, 'omnitest/command/generators/code2doc'
+      autoload :Documentation, 'omnitest/command/generators/documentation'
+    end
+  end
+
+  module CLI
+    class BaseCLI < Omnitest::Core::CLI
+      # The maximum number of concurrent instances that can run--which is a bit
+      # high
+      MAX_CONCURRENCY = 9999
+
+      # Constructs a new instance.
+      def initialize(*args)
+        super
+        $stdout.sync = true
+      end
+
+      protected
+
+      # Convert a Thor Option object to a hash so we can copy options from
+      # other commands.
+      #
+      # @param [Thor::Option] an option object
+      # @return [Hash] the options as a hash
+      # @api private
+      def self.option_to_hash(option)
+        [
+          :banner, :default, :description, :enum, :name,
+          :required, :type, :aliases, :group, :hide, :lazy_default
+        ].each_with_object({}) do | option_type, options_hash |
+          options_hash[option_type] = option.send(option_type)
+        end
+      end
+
+      # Ensure the any failing commands exit non-zero.
+      #
+      # @return [true] you die always on failure
+      # @api private
+      def self.exit_on_failure?
+        true
+      end
+
+      # @return [Logger] the common logger
+      # @api private
+      def logger
+        Omnitest.logger
+      end
+
+      # Update and finalize options for logging, concurrency, and other concerns.
+      #
+      # @api private
+      def update_config!
+        Omnitest.update_config!(@options)
+      end
+
+      # If auto_init option is active, invoke the init generator.
+      #
+      # @api private
+      def ensure_initialized
+      end
+
+      def duration(total)
+        total = 0 if total.nil?
+        minutes = (total / 60).to_i
+        seconds = (total - (minutes * 60))
+        format('(%dm%.2fs)', minutes, seconds)
+      end
+    end
+
+    class CrosstaskCLI < BaseCLI
+      desc 'clone [PROJECT|REGEXP|all]', 'Fetches the projects from version control'
+      method_option :concurrency,
+                    aliases: '-c',
+                    type: :numeric,
+                    lazy_default: MAX_CONCURRENCY,
+                    desc: <<-DESC.gsub(/^\s+/, '').gsub(/\n/, ' ')
+          Run the task against all matching instances concurrently. Only N
+          instances will run at the same time if a number is given.
+        DESC
+      method_option :log_level,
+                    aliases: '-l',
+                    desc: 'Set the log level (debug, info, warn, error, fatal)'
+      method_option :file,
+                    aliases: '-f',
+                    desc: 'The Omnitest project set file',
+                    default: 'omnitest.yaml'
+      def clone(*args)
+        update_config!
+        Omnitest.clone(*args)
+      end
+
+      desc 'workflow <name> [PROJECT|REGEXP|all]', 'Run the workflow against each project'
+      method_option :concurrency,
+                    aliases: '-c',
+                    type: :numeric,
+                    lazy_default: MAX_CONCURRENCY,
+                    desc: <<-DESC.gsub(/^\s+/, '').gsub(/\n/, ' ')
+          Run the task against all matching instances concurrently. Only N
+          instances will run at the same time if a number is given.
+        DESC
+      method_option :log_level,
+                    aliases: '-l',
+                    desc: 'Set the log level (debug, info, warn, error, fatal)'
+      method_option :file,
+                    aliases: '-f',
+                    desc: 'The Omnitest project set file',
+                    default: 'omnitest.yaml'
+      method_option :travis, type: :boolean, desc: "Enable/disable delegation to travis-build, if it's available"
+      def workflow(name, project_regex = 'all')
+        abort 'A workflow name is required' if args.empty?
+        update_config!
+        Omnitest.workflow(project_regex, name)
+      end
+
+      Psychic::CLI.commands.each do | action, command |
+        next if action == 'workflow' # We've customized it a bit
+
+        enhanced_banner = "#{action} [PROJECT|REGEXP|all]"
+        desc enhanced_banner, command.description
+        long_desc command.long_description
+        method_option :file,
+                      aliases: '-f',
+                      desc: 'The Omnitest project set file',
+                      default: 'omnitest.yaml'
+        method_option :travis, type: :boolean, desc: "Enable/disable delegation to travis-build, if it's available"
+        command.options.select do | name, option |
+          method_option name, option_to_hash(option)
+        end
+        define_method(action) do |*args|
+          update_config!
+          Omnitest.public_send(action, *args)
+        end
+      end
+    end
+
+    class CrossdocCLI < BaseCLI
+      register Command::Generate::Dashboard, 'dashboard', 'dashboard', 'Create a report dashboard'
+      tasks['dashboard'].options = Command::Generate::Dashboard.class_options
+
+      register Command::Generate::Code2Doc, 'code2doc', 'code2doc [PROJECT|REGEXP|all] [SCENARIO|REGEXP|all]',
+               'Generates documenation from sample code for one or more scenarios'
+      tasks['code2doc'].options = Command::Generate::Code2Doc.class_options
+
+      register Command::Generate::Documentation, 'generate', 'generate', 'Generates documentation, reports or other files from templates'
+      tasks['generate'].options = Command::Generate::Documentation.class_options
+      tasks['generate'].long_description = <<-eos
+      Generates documentation, reports or other files from templates. The templates may use Thor actions and Padrino helpers
+      in order to inject data from Omnitest test runs, code samples, or other sources.
+
+      Available templates: #{Command::Generate::Documentation.generator_names.join(', ')}
+      You may also run it against a directory containing a template with the --source option.
+      eos
+    end
+
+    class OmnitestCLI < CrosstaskCLI # rubocop:disable ClassLength
+      def self.filter_options
+        method_option :failed,
+                      type: :boolean,
+                      desc: 'Only list tests that failed / passed'
+        method_option :skipped,
+                      type: :boolean,
+                      desc: 'Only list tests that were skipped / executed'
+        method_option :samples,
+                      type: :boolean,
+                      desc: 'Only list tests that have sample code / do not have sample code'
+      end
+
+      Skeptic::CLI.commands.each do | action, command |
+        enhanced_banner = "#{action} [PROJECT|REGEXP|all] [SCENARIO|REGEXP|all]"
+        desc enhanced_banner, command.description
+        long_desc command.long_description
+        method_option :file,
+                      aliases: '-f',
+                      desc: 'The Omnitest project set file',
+                      default: 'omnitest.yaml'
+        command.options.select do | name, option |
+          method_option name, option_to_hash(option)
+        end
+        define_method action do |*args|
+          update_config!
+          Omnitest.public_send(action, *args)
+        end
+      end
+
+      desc 'list [PROJECT|REGEXP|all] [SCENARIO|REGEXP|all]', 'Lists one or more scenarios'
+      method_option :log_level,
+                    aliases: '-l',
+                    desc: 'Set the log level (debug, info, warn, error, fatal)'
+      method_option :format,
+                    desc: 'List output format',
+                    enum: %w(text markdown json yaml),
+                    default: 'text'
+      method_option :file,
+                    aliases: '-f',
+                    desc: 'The Omnitest project set file',
+                    default: 'omnitest.yaml'
+      method_option :skeptic,
+                    aliases: '-s',
+                    desc: 'The Skeptic test manifest file',
+                    default: 'skeptic.yaml'
+      method_option :test_dir,
+                    aliases: '-t',
+                    desc: 'The Omnitest test directory',
+                    default: 'tests/omnitest'
+      method_option :source,
+                    desc: 'Display the path to source code in the list?',
+                    type: :boolean
+      filter_options
+      def list(*args)
+        update_config!
+        perform('list', 'list', args, options)
+      end
+
+      desc 'show [PROJECT|REGEXP|all] [SCENARIO|REGEXP|all]', 'Show detailed status for one or more scenarios'
+      method_option :log_level,
+                    aliases: '-l',
+                    desc: 'Set the log level (debug, info, warn, error, fatal)'
+      method_option :format,
+                    desc: 'List output format',
+                    enum: %w(text markdown json yaml),
+                    default: 'text'
+      method_option :file,
+                    aliases: '-f',
+                    desc: 'The Omnitest project set file',
+                    default: 'omnitest.yaml'
+      method_option :skeptic,
+                    aliases: '-s',
+                    desc: 'The Skeptic test manifest file',
+                    default: 'skeptic.yaml'
+      method_option :source,
+                    desc: 'Display the source code for the sample'
+      method_option :test_dir,
+                    aliases: '-t',
+                    desc: 'The Omnitest test directory',
+                    default: 'tests/omnitest'
+      filter_options
+      def show(*args)
+        update_config!
+        perform('show', 'show', args, options)
+      end
+
+      desc 'test [PROJECT|REGEXP|all] [SCENARIO|REGEXP|all]',
+           'Test (clone, bootstrap, exec, and verify) one or more scenarios'
+      long_desc <<-DESC
+        The scenario states are in order: cloned, bootstrapped, executed, verified.
+        Test changes the state of one or more scenarios executes
+        the actions for each state up to verify.
+      DESC
+      method_option :concurrency,
+                    aliases: '-c',
+                    type: :numeric,
+                    lazy_default: MAX_CONCURRENCY,
+                    desc: <<-DESC.gsub(/^\s+/, '').gsub(/\n/, ' ')
+          Run a test against all matching instances concurrently. Only N
+          instances will run at the same time if a number is given.
+        DESC
+      method_option :log_level,
+                    aliases: '-l',
+                    desc: 'Set the log level (debug, info, warn, error, fatal)'
+      method_option :file,
+                    aliases: '-f',
+                    desc: 'The Omnitest project set file',
+                    default: 'omnitest.yaml'
+      method_option :skeptic,
+                    aliases: '-s',
+                    desc: 'The Skeptic test manifest file',
+                    default: 'skeptic.yaml'
+      method_option :test_dir,
+                    aliases: '-t',
+                    desc: 'The Omnitest test directory',
+                    default: 'tests/omnitest'
+      def test(*args)
+        update_config!
+        action_options = options.dup
+        perform('test', 'test', args, action_options)
+      end
+
+      desc 'version', "Print Omnitest's version information"
+      def version
+        puts "Omnitest version #{Omnitest::VERSION}"
+      end
+      map %w(-v --version) => :version
+    end
+  end
+end

data/lib/omnitest/command.rb

@@ -0,0 +1,103 @@
+require 'thread'
+require 'English'
+
+module Omnitest
+  module Command
+    class Base # rubocop:disable ClassLength
+      include Core::DefaultLogger
+      include Omnitest::Core::Logging
+      include Omnitest::Core::FileSystem
+
+      # Contstructs a new Command object.
+      #
+      # @param cmd_args [Array] remainder of the arguments from processed ARGV
+      # @param cmd_options [Hash] hash of Thor options
+      # @param options [Hash] configuration options
+      # @option options [String] :action action to take, usually corresponding
+      #   to the subcommand name (default: `nil`)
+      # @option options [proc] :help a callable that displays help for the
+      #   command
+      # @option options [Config] :test_dir a Config object (default: `nil`)
+      # @option options [Loader] :loader a Loader object (default: `nil`)
+      # @option options [String] :shell a Thor shell object
+      def initialize(action, cmd_args, cmd_options, options = {})
+        @action = action
+        @args = cmd_args
+        @options = cmd_options
+        @help = options.fetch(:help, -> { 'No help provided' })
+        @project_set_file = options.fetch('file', nil)
+        @skeptic_file = options.fetch('skeptic', nil)
+        @loader = options.fetch(:loader, nil)
+        @shell = options.fetch(:shell)
+        @queue = Queue.new
+      end
+
+      private
+
+      # @return [Array] remainder of the arguments from processed ARGV
+      # @api private
+      attr_reader :args
+
+      # @return [Hash] hash of Thor options
+      # @api private
+      attr_reader :options
+
+      # @return [proc] a callable that displays help for the command
+      # @api private
+      attr_reader :help
+
+      # @return [Thor::Shell] a Thor shell object
+      # @api private
+      attr_reader :shell
+
+      # @return [String] the action to perform
+      # @api private
+      attr_reader :action
+
+      def setup
+        Omnitest.setup
+      end
+
+      def project_set_file
+        @project_set_file ||= Omnitest.configuration.file
+        @project_set_file
+      end
+
+      # Emit an error message, display contextual help and then exit with a
+      # non-zero exit code.
+      #
+      # **Note** This method calls exit and will not return.
+      #
+      # @param msg [String] error message
+      # @api private
+      def die(msg)
+        logger.error "\n#{msg}\n\n"
+        help.call
+        exit 1
+      end
+
+      def select_projects(project_regexp = 'all', options = {})
+        projects = Omnitest.filter_projects(project_regexp, options)
+        die "No projects matching regex `#{project_regexp}', known projects: #{Omnitest.projects.map(&:name)}" if projects.empty?
+        projects
+      end
+
+      # Return an array on scenarios whos name matches the regular expression,
+      # the full instance name, or  the `"all"` literal.
+      #
+      # @param arg [String] an instance name, a regular expression, the literal
+      #   `"all"`, or `nil`
+      # @return [Array<Instance>] an array of scenarios
+      # @api private
+      def parse_subcommand(project_regexp = 'all', scenario_regexp = 'all', options = {})
+        scenarios = Omnitest.scenarios(project_regexp, scenario_regexp, options)
+        die "No scenarios for regex `#{scenario_regexp}', try running `omnitest list'" if scenarios.empty?
+        scenarios
+      rescue RegexpError => e
+        die 'Invalid Ruby regular expression, ' \
+          'you may need to single quote the argument. ' \
+          "Please try again or consult http://rubular.com/ (#{e.message})"
+      end
+    end
+  end
+end

data/lib/omnitest/command/generate.rb

@@ -0,0 +1,29 @@
+module Omnitest
+  module Command
+    class Generate < Thor
+      namespace :generate
+
+      autoload :Dashboard, 'omnitest/command/generators/dashboard'
+      register Dashboard, 'dashboard', 'dashboard', 'Create a report dashboard'
+      tasks['dashboard'].options = Dashboard.class_options
+
+      autoload :Code2Doc, 'omnitest/command/generators/code2doc'
+      register Code2Doc, 'code2doc', 'code2doc [PROJECT|REGEXP|all] [SCENARIO|REGEXP|all]',
+               'Generates documenation from sample code for one or more scenarios'
+      tasks['code2doc'].options = Command::Generate::Code2Doc.class_options
+
+      autoload :Documentation, 'omnitest/command/generators/documentation'
+      register Documentation, 'generate', 'generate', 'Generates documentation, reports or other files from templates'
+      tasks['generate'].options = Documentation.class_options
+      tasks['generate'].long_description = <<-eos
+      Generates documentation, reports or other files from templates. The templates may use Thor actions and Padrino helpers
+      in order to inject data from Omnitest test runs, code samples, or other sources.
+
+      Available templates: #{Command::Generate::Documentation.generator_names.join(', ')}
+      You may also run it against a directory containing a template with the --source option.
+      eos
+
+      # FIXME: Help shows unwanted usage, e.g. "omnitest omnitest:command:report:code2_doc"
+    end
+  end
+end

data/lib/omnitest/command/generators/code2doc.rb

@@ -0,0 +1,79 @@
+require 'json'
+require 'omnitest/reporters'
+require 'omnitest/documentation_generator'
+
+module Omnitest
+  module Command
+    class Generate
+      class Code2Doc < Thor::Group
+        include Core::DefaultLogger
+        include Omnitest::Core::Logging
+        include Thor::Actions
+        include Omnitest::Core::FileSystem
+        include Omnitest::Core::Util::String
+
+        class_option :log_level,
+                     aliases: '-l',
+                     desc: 'Set the log level (debug, info, warn, error, fatal)'
+        class_option :file,
+                     aliases: '-f',
+                     desc: 'The Omnitest project set file',
+                     default: 'omnitest.yaml'
+        class_option :skeptic,
+                     aliases: '-s',
+                     desc: 'The Skeptic test manifest file',
+                     default: 'skeptic.yaml'
+        class_option :format,
+                     aliases: '-f',
+                     enum: %w(md rst),
+                     default: 'md',
+                     desc: 'Target documentation format'
+        class_option :target_dir,
+                     aliases: '-d',
+                     default: 'docs/',
+                     desc: 'The target directory where documentation for generated documentation.'
+        class_option :source_files, type: :array
+
+        class_option :destination, default: 'docs/'
+
+        argument :project_regexp, default: 'all'
+        argument :scenario_regexp, default: 'all'
+
+        def setup
+          Omnitest.update_config!(options)
+          Omnitest.setup
+          @scenarios = Omnitest.scenarios(project_regexp, scenario_regexp, options)
+          abort "No scenarios for regex `#{scenario_regexp}', try running `omnitest list'" if @scenarios.empty?
+        end
+
+        def set_destination_root
+          self.destination_root = options[:destination]
+        end
+
+        def source_files
+          @source_files = @scenarios.map do |scenario|
+            [scenario.slug, scenario.absolute_source_file]
+          end
+        end
+
+        def code2doc
+          @source_files.each do |slug, source_file|
+            if source_file.nil?
+              warn "No code sample available for #{slug}, no documentation will be generated."
+              next
+            end
+
+            target_file_name = slug + ".#{options[:format]}"
+
+            begin
+              doc = Omnitest::DocumentationGenerator.new.code2doc(source_file)
+              create_file(target_file_name, doc)
+            rescue Omnitest::Psychic::Code2Doc::CommentStyles::UnknownStyleError
+              warn "Could not generated documentation for #{source_file}, because the language couldn't be detected."
+            end
+          end
+        end
+      end
+    end
+  end
+end