local_ci 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 325240cf896966e5fe98d945c9485e3f4b30a32db4762d77f5c3e97664e3f7b1
-  data.tar.gz: dc2630284356e1ba3a7f22f97107d7c429f423daf2a0e64835b6803e7c935aef
+  metadata.gz: c05d333270ce461c92b586bae503e0f2fca0ad8fed179dad1c610062f6627bd6
+  data.tar.gz: f63be5d9621379360a8a1cd46dc7f656bdc410f6b6f9639beb87ff11978ee80a
 SHA512:
-  metadata.gz: bcbcbe5912235021b56063ebe5b94bf09af69d82aaba2da3b378af1c7c98bf779d684db9eb301c99e231a0af7bf38f5fef69c359bfd82d9aa4b7dc90858851eb
-  data.tar.gz: b23429e6de91524c432b99951a1e060cfaaa0de32be800591f1020a44f4d1c7aca7db5fd317b2cf6aaccb4517eb59a24c37c73a85a28f6f5e846a88a4fc73443
+  metadata.gz: 76685dda1903180053beb224fe5a48e1defaeab1c2bdf247a33bfcaa55342d1aa07f95e123bbb6a8301de9eac1cb174b1683f8bdc8d53a3db33df2494bbabdba
+  data.tar.gz: 5eb63c6ba26175a8b8c488388314d887d0c04c7a8621fba2e3ae1cb2ba262a7e686bac8f9eb62de1a9a3718cf7c1ef3c2f69fef70752d72bc96c83d2fd87eab1

data/lib/local_ci/dsl.rb

@@ -26,5 +26,13 @@ module LocalCI
 
       LocalCI::Flow.new(name: name, heading: heading, parallel: parallel, block: block)
     end
+
+    def ci?
+      LocalCI::Helper.ci?
+    end
+
+    def local?
+      LocalCI::Helper.local?
+    end
   end
 end

data/lib/local_ci/flow.rb

@@ -25,42 +25,64 @@ module LocalCI
       LocalCI::ExecContext.new(flow: self).instance_exec(&block)
     end
 
-    def actions? = !!@actions
+    def actions?
+      !!@actions
+    end
 
-    def actionless? = !actions?
+    def actionless?
+      !actions?
+    end
 
-    def isolated? = LocalCI::Task["ci"].already_invoked
+    def parallel?
+      @parallel
+    end
 
-    private
+    def isolated?
+      !LocalCI::Task["ci"].already_invoked
+    end
 
-    def setup_required_tasks
-      ci_task = LocalCI::Task["ci", "Run the CI suite"]
+    def raise_failures
+      LocalCI::Task["ci:teardown"].invoke
+      output.failures
 
-      LocalCI::Task["ci:setup", "Setup the system to run CI"]
-      LocalCI::Task["ci:teardown", "Cleanup after the CI"]
+      abort LocalCI::Helper.pastel.red("#{@heading} failed, see ci.log for more.")
+    end
 
-      ci_task.add_prerequisite "ci:setup"
-      ci_task.define do
-        LocalCI::Task["ci:teardown"].invoke
-      end
+    def setup_task
+      "#{@task}:setup"
+    end
+
+    def jobs_task
+      "#{@task}:jobs"
+    end
+
+    def teardown_task
+      "#{@task}:teardown"
+    end
+
+    private
+
+    def setup_required_tasks
+      LocalCI::Task["ci"].add_prerequisite "ci:setup"
     end
 
     def setup_flow_tasks
-      LocalCI::Task["#{@task}:setup"]
+      LocalCI::Task[setup_task]
 
-      LocalCI::Task.new("#{@task}:jobs", parallel_prerequisites: @parallel)
+      LocalCI::Task.new(jobs_task, parallel_prerequisites: @parallel)
 
-      LocalCI::Task["#{@task}:teardown"]
+      LocalCI::Task[teardown_task]
       LocalCI::Task[@task, @heading]
 
-      LocalCI::Task["#{@task}:setup"]
-      LocalCI::Task["#{@task}:setup"].add_prerequisite "ci:setup"
+      LocalCI::Task[setup_task]
+      LocalCI::Task[setup_task].add_prerequisite "ci:setup"
 
-      LocalCI::Task[@task].add_prerequisite "#{@task}:teardown"
-      LocalCI::Task["#{@task}:teardown"].add_prerequisite "#{@task}:jobs"
-      LocalCI::Task["#{@task}:jobs"].add_prerequisite "#{@task}:setup"
+      LocalCI::Task[@task].add_prerequisite jobs_task
+      LocalCI::Task[jobs_task].add_prerequisite setup_task
 
       LocalCI::Task["ci"].add_prerequisite @task
+
+      LocalCI.flows << self
     end
 
     def setup_actionless_flow_tasks
@@ -71,15 +93,10 @@ module LocalCI
 
     def after_jobs
       LocalCI::Task[@task].define do
-        LocalCI::Task["#{@task}:teardown"].invoke
-        LocalCI::Task["ci:teardown"].invoke unless isolated? || actionless?
-
-        if @failures.any?
-          LocalCI::Task["ci:teardown"].invoke
-          output.failures
+        LocalCI::Task[teardown_task].invoke
+        LocalCI::Task["ci:teardown"].invoke unless !isolated? || actionless?
 
-          abort LocalCI::Helper.pastel.red("#{@heading} failed, see ci.log for more.")
-        end
+        raise_failures if @failures.any?
       end
     end
   end

data/lib/local_ci/generator/buildkite.rb

@@ -0,0 +1,41 @@
+module LocalCI
+  module Generator
+    module Buildkite
+      def self.pipeline
+        puts steps.to_yaml
+      end
+
+      def self.steps
+        {
+          "steps" => LocalCI.flows.flat_map do |flow|
+            step = {}
+
+            if flow.parallel?
+              step["group"] = flow.heading
+              step["steps"] = []
+
+              flow.jobs.each do |job|
+                step["steps"] << {
+                  "label" => job.name,
+                  "commands" => [
+                    "bundle check &> /dev/null || bundle install",
+                    "bundle exec rake #{job.task}"
+                  ]
+                }
+              end
+
+            else
+              step["label"] = flow.heading
+              step["commands"] = [
+                "bundle check &> /dev/null || bundle install",
+                "bundle exec rake #{flow.task}"
+              ]
+            end
+
+            [step, "wait"]
+          end
+        }
+      end
+    end
+  end
+end

data/lib/local_ci/generator/semaphore_ci.rb

@@ -0,0 +1,55 @@
+module LocalCI
+  module Generator
+    module SemaphoreCI
+      def self.pipeline
+        FileUtils.mkdir_p(".semaphore")
+        File.write(".semaphore/semaphore.yml", blocks.to_yaml)
+      end
+
+      def self.blocks
+        {
+          "version" => "v1.0",
+          "name" => "CI",
+          "agent" => {
+            "machine" => {
+              "type" => "f1-standard-2",
+              "os_image" => "ubuntu2404"
+            }
+          },
+
+          "blocks" => LocalCI.flows.flat_map do |flow|
+            block = {
+              "name" => flow.heading,
+              "task" => {"jobs" => []}
+            }
+
+            if flow.parallel?
+              flow.jobs.each do |job|
+                block["task"]["jobs"] << {
+                  "name" => job.name,
+                  "commands" => [
+                    "checkout",
+                    "bundle check &> /dev/null || bundle install",
+                    "bundle exec rake #{job.task}"
+                  ]
+                }
+              end
+
+            else
+              block["task"]["jobs"] << {
+                "name" => flow.heading,
+                "commands" => [
+                  "checkout",
+                  "bundle check &> /dev/null || bundle install",
+                  "bundle exec rake #{flow.task}"
+                ]
+              }
+            end
+
+            block
+          end
+        }
+      end
+    end
+  end
+end

data/lib/local_ci/helper.rb

@@ -1,11 +1,57 @@
 module LocalCI
   module Helper
-    def self.color? = TTY::Color.support?
-    def self.pastel = @pastel ||= Pastel.new(enabled: color?)
-    def self.runner = @runner ||= TTY::Command.new(color: color?, output: Logger.new("ci.log"))
+    def self.color?
+      TTY::Color.support?
+    end
+
+    def self.pastel
+      @pastel ||= Pastel.new(enabled: color?)
+    end
+
+    def self.runner
+      @runner ||= TTY::Command.new(color: color?, output: logger)
+    end
+
+    def self.logger
+      return Logger.new($stdout) if ENV.has_key?("LOCAL_CI_LOG_TO_STDOUT")
+
+      log_file = ci? ? $stdout : "logs/local_ci.log"
+      log_file = ENV.fetch("LOCAL_CI_LOG_FILE", log_file)
+
+      FileUtils.mkdir_p(File.dirname(log_file)) unless log_file == $stdout
+
+      Logger.new(log_file)
+    end
 
     def self.taskize(heading)
       heading.downcase.gsub(/\s/, "_").gsub(/[^\w]/, "").to_sym
     end
+
+    def self.human_duration(time_span)
+      seconds = time_span.dup
+      minutes = (seconds / 60).to_i
+      hours = minutes / 60
+
+      seconds %= 60
+      minutes %= 60
+
+      if hours >= 1
+        "#{hours}h #{minutes}m"
+
+      elsif minutes >= 1
+        "#{minutes}m #{seconds.floor}s"
+
+      else
+        "%.2fs" % seconds
+      end
+    end
+
+    def self.ci?
+      ENV.has_key?("CI")
+    end
+
+    def self.local?
+      !ci?
+    end
   end
 end

data/lib/local_ci/job.rb

@@ -1,6 +1,6 @@
 module LocalCI
   class Job
-    attr_reader :flow, :name, :command, :block, :task, :state, :duration
+    attr_reader :flow, :name, :command, :block, :task, :state
 
     def initialize(flow:, name:, command:, block:)
       @flow = flow
@@ -18,7 +18,7 @@ module LocalCI
       ::Rake::Task.define_task(task) do
         @state = :running
         @flow.output.update(self)
-        start = Time.now
+        @start = Time.now
 
         if block
           LocalCI::ExecContext.new(flow: @flow).instance_exec(&block)
@@ -32,20 +32,51 @@ module LocalCI
           job: @name,
           message: e.message
         )
+
+        @flow.raise_failures if isolated?
       ensure
-        @duration = Time.now - start
+        @duration = duration
         @flow.output.update(self)
+
+        if isolated?
+          ::Rake::Task[@flow.teardown_task].invoke
+          ::Rake::Task["ci:teardown"].invoke
+        end
       end
 
-      ::Rake::Task["#{@flow.task}:jobs"].prerequisites << task
+      ::Rake::Task[@flow.jobs_task].prerequisites << task
+
+      ::Rake::Task[task].prerequisites << @flow.setup_task if @flow.actions?
+    end
 
-      ::Rake::Task[task].prerequisites << "#{@flow.task}:setup" if @flow.actions?
+    def isolated?
+      !LocalCI::Task[@flow.task].already_invoked
     end
 
-    def waiting? = @state == :waiting
-    def running? = @state == :running
-    def success? = @state == :success
-    def failed? = @state == :failed
-    def done? = [:success, :failed].include? @state
+    def duration
+      return if @start.nil?
+
+      @duration || Time.now - @start
+    end
+
+    def waiting?
+      @state == :waiting
+    end
+
+    def running?
+      @state == :running
+    end
+
+    def success?
+      @state == :success
+    end
+
+    def failed?
+      @state == :failed
+    end
+
+    def done?
+      [:success, :failed].include? @state
+    end
   end
 end

data/lib/local_ci/output.rb

@@ -24,26 +24,64 @@ module LocalCI
       @thread.join
     end
 
-    def pastel = LocalCI::Helper.pastel
-    def cursor = TTY::Cursor
-    def screen = TTY::Screen
-    def tty? = $stdout.isatty
+    def pastel
+      LocalCI::Helper.pastel
+    end
+
+    def cursor
+      TTY::Cursor
+    end
+
+    def screen
+      TTY::Screen
+    end
+
+    def tty?
+      $stdout.isatty
+    end
+
+    def style
+      result = LocalCI::Helper.ci? ? "plain" : "realtime"
+      result = "plain" unless tty?
+      result = ENV.fetch("LOCAL_CI_STYLE", result)
+
+      unless ["plain", "json", "realtime"].include? result
+        raise ArgumentError, "LOCAL_CI_STYLE must be one of plain, json, or realtime"
+      end
 
-    def passed? = @flow.jobs.all?(&:success?)
-    def failed? = @flow.failures.any?
-    def done? = @flow.jobs.all?(&:done?)
+      result
+    end
+
+    def passed?
+      @flow.jobs.all?(&:success?)
+    end
+
+    def failed?
+      @flow.failures.any?
+    end
+
+    def done?
+      @flow.jobs.all?(&:done?)
+    end
 
     def update(job)
-      if tty?
+      case style
+      when "realtime"
         finish and return if done?
 
         return if @thread&.alive?
 
         start_thread
-      else
+
+      when "json"
         @job = job
 
         @mutex.synchronize { json_output }
+
+      when "plain"
+        @job = job
+
+        @mutex.synchronize { plain_output }
       end
     end
 
@@ -62,6 +100,7 @@ module LocalCI
     end
 
     def draw(final: false)
+      print cursor.hide
       if @first_paint
         @start = Time.now
         @first_paint = false
@@ -70,10 +109,12 @@ module LocalCI
       end
 
       puts heading_line
-      @flow.jobs.each { puts job_line it }
+      @flow.jobs.each { |job| puts job_line job }
       puts footer_line
 
       puts if final
+    ensure
+      print cursor.show
     end
 
     def color(message)
@@ -102,35 +143,24 @@ module LocalCI
 
       result = cursor.clear_line
       if job.waiting?
-        result << "[ ] #{name}"
+        result << "[ ] "
       elsif job.running?
-        result << "[-] #{name}"
+        result << "[-] "
       elsif job.success?
-        result << "[#{pastel.green "✓"}] #{name}"
+        result << "[#{pastel.green "✓"}] "
       elsif job.failed?
-        result << "[#{pastel.red "✗"}] #{name}"
+        result << "[#{pastel.red "✗"}] "
       end
 
+      result << name
+
+      result << " (#{pastel.yellow LocalCI::Helper.human_duration(job.duration)})" unless job.waiting?
+
       result
     end
 
     def duration
-      seconds = Time.now - @start
-      minutes = (seconds / 60).to_i
-      hours = minutes / 60
-
-      seconds %= 60
-      minutes %= 60
-
-      if hours >= 1
-        "#{hours}h #{minutes}m"
-
-      elsif minutes >= 1
-        "#{minutes}m #{seconds.floor}s"
-
-      else
-        "%.2fs" % seconds
-      end
+      LocalCI::Helper.human_duration(Time.now - @start)
     end
 
     def footer_line
@@ -146,5 +176,16 @@ module LocalCI
         state: @job.state
       }.to_json)
     end
+
+    def plain_output
+      result = "=== #{@flow.heading} - #{@job.name} [#{@job.state}] "
+      result << if @job.waiting? || @job.running?
+        "==="
+      else
+        "(#{LocalCI::Helper.human_duration(@job.duration)}) ==="
+      end
+
+      puts(result)
+    end
   end
 end

data/lib/local_ci/rake.rb

@@ -2,6 +2,23 @@ module LocalCI
   module Rake
     def self.setup(klass)
       klass.send(:include, LocalCI::DSL)
+
+      ci_task = LocalCI::Task["ci", "Run the CI suite"]
+      LocalCI::Task["ci:setup", "Setup the system to run CI"]
+      LocalCI::Task["ci:teardown", "Cleanup after the CI"]
+
+      ci_task.add_prerequisite "ci:setup"
+      ci_task.define do
+        LocalCI::Task["ci:teardown"].invoke
+      end
+
+      LocalCI::Task["ci:generate:buildkite", "Prints the contents of a Buildkite pipeline.yml the CI suite"] do
+        LocalCI::Generator::Buildkite.pipeline
+      end
+
+      LocalCI::Task["ci:generate:semaphore_ci", "Writes a .semaphore/semaphore.yml file for the CI suite"] do
+        LocalCI::Generator::SemaphoreCI.pipeline
+      end
     end
   end
 end

data/lib/local_ci/task.rb

@@ -2,8 +2,10 @@ module LocalCI
   class Task
     extend Forwardable
 
-    def self.[](task, comment = nil)
-      new(task, comment: comment)
+    def self.[](task, comment = nil, &block)
+      new_task = new(task, comment: comment)
+      new_task.define(&block) if block_given?
+      new_task
     end
 
     attr_accessor :task

data/lib/local_ci.rb

@@ -1,6 +1,8 @@
+require "fileutils"
 require "forwardable"
 require "json"
 require "logger"
+require "yaml"
 
 require "tty-command"
 require "tty-cursor"
@@ -16,3 +18,14 @@ require "local_ci/job"
 require "local_ci/output"
 require "local_ci/rake"
 require "local_ci/task"
+
+require "local_ci/generator/buildkite"
+require "local_ci/generator/semaphore_ci"
+
+module LocalCI
+  @flows = []
+
+  def self.flows
+    @flows
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: local_ci
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Sean Earle
@@ -9,6 +9,34 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -93,38 +121,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A way to run CI locally but also able to run easily on your hosted CI
 email: sean.r.earle@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
-- Rakefile
 - lib/local_ci.rb
 - lib/local_ci/dsl.rb
 - lib/local_ci/exec_context.rb
 - lib/local_ci/failure.rb
 - lib/local_ci/flow.rb
+- lib/local_ci/generator/buildkite.rb
+- lib/local_ci/generator/semaphore_ci.rb
 - lib/local_ci/helper.rb
 - lib/local_ci/job.rb
 - lib/local_ci/output.rb
 - lib/local_ci/rake.rb
 - lib/local_ci/task.rb
-- local_ci.gemspec
-- spec/spec_helper.rb
-- spec/support/dsl_klass.rb
-- spec/unit/local_ci/dsl_spec.rb
-- spec/unit/local_ci/exec_context_spec.rb
-- spec/unit/local_ci/failure_spec.rb
-- spec/unit/local_ci/flow_spec.rb
-- spec/unit/local_ci/helper_spec.rb
-- spec/unit/local_ci/job_spec.rb
-- spec/unit/local_ci/output_spec.rb
-- spec/unit/local_ci/rake_spec.rb
-- spec/unit/local_ci/task_spec.rb
 homepage: https://github.com/HellRok/local_ci
 licenses:
 - MIT
@@ -143,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Run CI locally
 test_files: []

data/.gitignore

@@ -1,2 +0,0 @@
-*.log
-*.gem