ci-helper 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fae9814d6c5c741111d1ad0c088c82e559de3104654182a4f31eecd899705d6b
-  data.tar.gz: f442afb5f64aaf8624e9b7b583b90a86046975570d12dd3a8a1d30b0cf6fd51a
+  metadata.gz: adbebe67fd86fd92ee630a21009a3c42fe6d4be32d9ebb773539cc92964bab77
+  data.tar.gz: ce5e94594b8392d5f0d7b1de9f4fd5c548d5598c0097192a98eb6718f8478493
 SHA512:
-  metadata.gz: df17b45dadbf7707cfcdc143eedacb2b01a210b49f107127541985f882a1f273d7578ff1e3506c0a386b357f486d40c4b5b10896d8f828bbd0eaddd784e1fdc5
-  data.tar.gz: 2604f25b03bfc9f2ed0cd654b8d2a0c111da92bfae8379f5b2eea8719af1d4e74ad590a94ffbf5a34d5004ce1b2f419ef453032e6f81fb35d7b03641df8a055d
+  metadata.gz: b98ad7e1d9b1cfa5a740c01ad854c697b65d41e070dbb132b5da44af2a9ada24140edbf80dca852fd9e0e3132a9ec911c8902dcf319d3120a16e2995eda810b1
+  data.tar.gz: 7eb7b22ffacf1b8f0951c8b116edfa67ccd2f55c244626e6d2484332c3dc4de891a7eff91bf0008cf3893be3f9474305076952b1c5ad6c5ce3b70b4b95c0a5fd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ci-helper (0.10.1)
+    ci-helper (0.10.2)
       colorize (~> 1.1)
       dry-inflector (~> 1.0)
       umbrellio-sequel-plugins (~> 0.14)

data/README.md

@@ -14,7 +14,7 @@ $ bundle install
 ```
 Or install it yourself as:
 ```bash
-$ gem install ci_helper
+$ gem install ci-helper
 ```
 
 ## Usage
@@ -42,28 +42,36 @@ List of available commands:
 * **BundlerAudit** — executes `bundler-audit`. Accepted flags: `--ignored-advisories`.
     * `--ignored-advisories [values]` — accepts advisory codes, delimited by comma.
 * **CheckDBDevelopment** — executes rails db commands (`db:drop`, `db:create`, `db:migrate`)
-    and seeds database. Does not accept flags.
+    and seeds database. Accepted flags: `--with-clickhouse`.
+    * `--with-clickhouse` — if set to `true`, also creates and migrates the ClickHouse
+        database (`ch:create`, `ch:migrate`).
 * **CheckDBRollback** — executes rails db commands with additional command
     `db:rollback_new_migrations`, which rollbacks migrations, added in tested branch.
-    Does not accept flags. Gem provides this rake task, but only for `Sequel`.
+    Gem provides this rake task, but only for `Sequel`.
     If you want to use `ActiveRecord::Migrator`, you'll have to write rake task by your own.
+    Accepted flags: `--with-clickhouse`.
+    * `--with-clickhouse` — if set to `true`, runs the same create/rollback/migrate cycle
+        for the ClickHouse database (`ch:create`, `ch:migrate`, `ch:rollback_new_migrations`).
 * **RubocopLint** — executes rubocop linter. Does not accept flags.
 * **RunSpecs** — executes `rspec` in project root.
-    Accepted flags: `--node-index`, `node-total`, `with-database`, `split-resultset`.
+    Accepted flags: `--node-index`, `--node-total`, `--with-database`, `--with-clickhouse`,
+    `--split-resultset`.
     * `--node-index` — if you run specs in parallel in CI, then you might use this flag.
     * `--node-total` — if you run specs in parallel in CI, then you might use this flag.
     * `--with-database` — if you want to prepare database before executing specs,
         you should set this flag to `true`.
+    * `--with-clickhouse` — if you want to prepare the ClickHouse database before executing
+        specs, you should set this flag to `true`.
     * `--split-resultset` — if you run specs in parallel in CI,
         then you might use this flag to `true`. If this flag set to true,
-        final `.resultset.json` will be renamed to `.resultset.#{node_index}.json`
+        final `.resultset.json` will be renamed to `resultset.#{node_index}.json`
 * **CheckSpecSuffixes** — checks specs in the spec subdirectories for `_spec` suffix,
     by default ignores directories `support`, `factories` and files with `context` suffix.
-    Accepted flags: `--extra_paths`, `--ignored_paths`.
+    Accepted flags: `--extra-paths`, `--ignored-paths`.
     * `--extra-paths [values]` - accepts additional path patterns that should be scanned,
-        delimited by coma.
+        delimited by comma.
     * `--ignored-paths [values]` - accepts path patterns that should be ignored,
-        delimited by coma.
+        delimited by comma.
 * **CheckCoverage** — checks coverage by executing `SimpleCov::collate`.
     Accepted flags: `--split-resultset`, `--setup-file-path`.
     * `--split-resultset` — if you execute command `RunSpecs` with `--split-resultset true`,
@@ -73,17 +81,17 @@ List of available commands:
     * `--setup-file-path` — relative path to your `.rb` file, which setups `SimpleCov`.
       Usually it is `spec_helper.rb`.
 * **CheckSidekiqSchedulerConfig** — checks `sidekiq_scheduler` config by trying to resolve jobs constants via `rails runner`.
-    Accepted flags: `--config-path`
+    Accepted flags: `--config-path`, `--with-database`.
     * `--config-path` — relative path to your config yaml file with schedule.
       Usually it is `config/sidekiq_scheduler.yml`.
-    * `--with-database` — if you want to prepare database before executing specs,
+    * `--with-database` — if you want to prepare the database before resolving job constants,
       you should set this flag to `true`.
 
 ### Rake Tasks
 
 As you can see, some commands use generic rake tasks. To make tasks available in your application,
 you need to require the file `ci_helper/railtie`. Also, you can require it directly in `Gemfile`:
-`gem "ci-helper", require: "ci_helper/railtie, group: :test`.
+`gem "ci-helper", require: "ci_helper/railtie", group: :test`.
 Or if you haven't set `require` option to `false`, rake tasks loads automatically.
 
 ### Script
@@ -110,7 +118,7 @@ You just need create gem with following structure:
       - cool_command.rb
 ```
 
-Where your `CoolCoomand` class may look something like this:
+Where your `CoolCommand` class may look something like this:
 ```ruby
 module CIHelper
   module Commands

data/lib/ci_helper/commands/run_specs.rb

@@ -50,10 +50,10 @@ module CIHelper
           begin
             execute(
               "bundle exec rspec --dry-run --format=json --out #{Shellwords.escape(output_file)}",
+              capture: true,
             )
-          rescue Error
-            output = File.exist?(output_file) ? File.read(output_file) : "(no output file)"
-            fail!("RSpec dry-run failed. Output file contents:\n#{output}")
+          rescue Error => error
+            fail!("RSpec dry-run failed:\n#{error.output}")
           end
           JSON.parse(File.read(output_file)).fetch("examples").map { |e| e.fetch("id") }
         end

data/lib/ci_helper/commands.rb

@@ -2,7 +2,14 @@
 
 module CIHelper
   module Commands
-    class Error < StandardError; end
+    class Error < StandardError
+      attr_reader :output
+
+      def initialize(message, output: nil)
+        super(message)
+        @output = output
+      end
+    end
 
     class BaseCommand
       class << self
@@ -26,16 +33,19 @@ module CIHelper
         execute(*commands)
       end
 
-      def execute(*commands)
+      def execute(*commands, capture: false)
         command = commands.join(" && ")
 
         process_stdout.puts(Tools::Colorize.command(command))
 
+        captured = +"" if capture
         Open3.popen2e(command) do |_stdin, stdout, thread|
-          stdout.each_char { |char| process_stdout.print(char) }
+          stdout.each_char { |char| capture ? captured << char : process_stdout.print(char) }
           exit_code = thread.value.exitstatus
 
-          fail!("Bad exit code #{exit_code} for command #{command.inspect}") unless exit_code.zero?
+          unless exit_code.zero?
+            fail!("Bad exit code #{exit_code} for command #{command.inspect}", output: captured)
+          end
           0
         end
       end
@@ -54,8 +64,8 @@ module CIHelper
         execute_with_env("bundle exec rake ch:create ch:migrate")
       end
 
-      def fail!(message)
-        raise Error, message
+      def fail!(message, output: nil)
+        raise Error.new(message, output: output)
       end
 
       def boolean_option?(key)

data/lib/ci_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CIHelper
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ci-helper
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - JustAnotherDude