semaph 0.4.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0677122d6857a85e92dc0a74346b4f130f1f715ad9cfede85ffab143540867e
-  data.tar.gz: c6165a0966dd6cd3088fcece1d56d304188c79552c03a0d48cb3addbe1e4649f
+  metadata.gz: 0653a67cbd9a978c6650491d39594eaf22d59b0be26d43bacc7a2f0933d5432c
+  data.tar.gz: 1ffb51d996af36938a6fc8b61e26da3db154161b7c420f31a8570a77545d6e1e
 SHA512:
-  metadata.gz: d2ea65f9d5fdaf2b4b0597dc3fd0205eaa7fad89b596dff1fcf6619c6d39d11c80c9b5f9acd4e375049c6e16a91bcc4df5708cfd6e1725e834c80576d1442dbf
-  data.tar.gz: 2505c4088ef17b9efdaa9c9d2dfc80159e459dfcc5f097d4761b69b2e390cb3371b611d9a913783812b5b1dd7435063ac8db3de2fb58f90168822068bcdc2ebf
+  metadata.gz: e7f196dfd55567cbd4621c0b2223b0367020d0c1d104560b108fc03a73846ccb56bbbca248321b0fb0c02c2ad4122c3093fe8280336440a2fc80c555bc191a5a
+  data.tar.gz: 59b468eccf7a64f79d4ea8317df870f24c4d3271d08a3616b992c9994fb4838276865ffc3fc47805795dec5f921323d53864a75c529e4852c9ac3cbe0f4b4ebd

data/.rubocop.yml

@@ -1,3 +1,42 @@
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 

data/.semaph

@@ -0,0 +1,9 @@
+---
+:host: markryall.semaphoreci.com
+:project:
+  spec:
+    repository:
+      url: git@github.com:markryall/semaph.git
+  metadata:
+    name: semaph
+    id: e75c6c57-2665-4e45-9cab-560508eb0b22

data/.semaphore/semaphore.yml

@@ -16,4 +16,8 @@ blocks:
       - name: Build
         commands:
           - checkout
-          - echo "done"
+          - sem-version ruby $(grep ruby .tool-versions | cut -d ' ' -f 2)
+          - cache restore $(git ls-tree HEAD Gemfile.lock | cut -f3 -d$' ' | cut -f1 -d$'\t')
+          - bundle install --deployment --path vendor/bundle
+          - cache store $(git ls-tree HEAD Gemfile.lock | cut -f3 -d$' ' | cut -f1 -d$'\t') vendor/bundle
+          - bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    semaph (0.4.0)
+    semaph (0.9.0)
       faraday
       rainbow
       shell_shock
@@ -9,18 +9,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     coderay (1.1.2)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     method_source (1.0.0)
     minitest (5.14.1)
     multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    rubocop (0.85.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
     shell_shock (0.0.5)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -29,6 +48,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   pry
   rake (~> 12.0)
+  rubocop
   semaph!
 
 BUNDLED WITH

data/README.md

@@ -60,8 +60,6 @@ If you have only one set of credentials in `~/.sem.yml` then this will be the in
 
 From here you can `list-projects` and then `select-project` to enter a shell for that project.
 
-If new projects have been added/removed while you are using this shell, you can `reload-projects`.
-
 ### project shell
 
      🏗  foo.semaphoreci.com my-app >
@@ -71,8 +69,8 @@ substring of the git branch you want to see workflows for) and then `select-work
 (where 'index' is the number displayed for each workflow `list-workflows` - tab completion on uuids
 seemed a bad idea) to enter a shell for that specific workflow.
 
-You can also `open-github` (opens a web browser for the github project associated with the project), `open-project`
-(opens the semaphoreci project in a browser) and `reload-workflows` (to see any new/changed workflows).
+You can also `open-github` (opens a web browser for the github project associated with the project) and `open-project`
+(opens the semaphoreci project in a browser).
 
 ### workflow shell
 
@@ -83,16 +81,22 @@ from `semaphore.yml` plus any promotion pipelines that might be executed.  You c
 what's happening with the pipeline.
 
 You can also `open-github-branch`, `open-github-commit` to see the branch/commit in a browser and
-`open-workflow`, `open-branch` to see the semaphore branch/workflow in a browser and `reload-pipelines` to see
-any changes that have happened in semaphore.
+`open-workflow`, `open-branch` to see the semaphore branch/workflow in a browser.
 
 ### pipeline shell
 
     🏗  foo.semaphoreci.com my-app workflowuuid semaphore.yml >
 
-From this shell, you can `list-jobs` and `reload-jobs`.
+From this shell, you can `list-jobs`, `poll-jobs`, `job-log` and `grep-logs`.
+
+Job polling will stop as soon as any one job has failed and send a system notification
+(as long as `terminal-notifier` is installed).
+
+You can look at the log for a specific job (by the index presented in `list-jobs`) using `less`.
+
+You can grep across all jobs (using `ag`) with `grep-logs` which will download the logs for all completed jobs.
 
-Jobs are displayed with a flattened view of blocks and jobs for compactness.
+You can also open the same browser views in semaphoreci and github from this shell.
 
 ## Development
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +8,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+RuboCop::RakeTask.new(:cop)
+
+task default: %i[cop test]

data/lib/semaph.rb

@@ -1,22 +1,57 @@
+require "semaph/client"
+require "semaph/model/project"
 require "semaph/version"
 require "semaph/shells/organisations/organisations_shell"
 require "semaph/shells/organisation/organisation_shell"
+require "semaph/shells/project/project_shell"
 require "yaml"
 
 module Semaph
   class Error < StandardError; end
 
   def self.console
-    yaml_path = File.join(File.expand_path("~"), ".sem.yaml")
-    raise "Please install the sem tool and authenticate to semaphoreci.com" unless File.exist?(yaml_path)
-
-    sem_config = YAML.load_file(yaml_path)
-    contexts = sem_config["contexts"]
+    organisations = load_organisations
+    config = load_config
 
-    if contexts.count == 1
-      Shells::Organisation::OrganisationShell.new(contexts.values.first).push
+    if config
+      console_with_config(organisations, config)
+    elsif organisations.count == 1
+      Shells::Organisation::OrganisationShell.new(organisations.first).push
     else
-      Shells::Organisations::OrganisationsShell.new(contexts).push
+      Shells::Organisations::OrganisationsShell.new(organisations).push
+    end
+  end
+
+  def self.console_with_config(organisations, config)
+    organisation = organisations.find { |o| o["host"] == config[:host] }
+
+    Shells::Project::ProjectShell.new(
+      Model::Project.new(
+        ::Semaph::Client.new(
+          organisation["auth"]["token"],
+          organisation["host"],
+        ),
+        config[:project],
+      ),
+    ).push
+  end
+
+  def self.load_organisations
+    yaml_path = File.join(File.expand_path("~"), ".sem.yaml")
+
+    unless File.exist?(yaml_path)
+      unless organisations
+        puts "Please install the sem tool and authenticate to semaphoreci.com"
+        exit 1
+      end
     end
+
+    YAML.load_file(yaml_path)["contexts"].values
+  end
+
+  def self.load_config
+    return nil unless File.exist?(".semaph")
+
+    YAML.load_file(".semaph")
   end
 end

data/lib/semaph/{api.rb → client.rb}

@@ -3,7 +3,17 @@ require "json"
 
 module Semaph
   # Refer to https://docs.semaphoreci.com/reference/api-v1alpha/
-  class Api
+  class Client
+    class RequestException < RuntimeError
+      attr_reader :url, :response
+
+      def initialize(url, response)
+        @url = url
+        @response = response
+        super("http response #{response.status} received for #{url}:\n#{response.body}")
+      end
+    end
+
     attr_reader :host, :name
 
     def initialize(token, host)
@@ -42,10 +52,22 @@ module Semaph
       get "pipelines/#{id}", { detailed: true }
     end
 
+    def promotions(pipeline_id)
+      get "promotions", { pipeline_id: pipeline_id }
+    end
+
+    def promote(pipeline_id, name)
+      post "promotions", { pipeline_id: pipeline_id, name: name }
+    end
+
     def job(id)
       get "jobs/#{id}"
     end
 
+    def stop_job(id)
+      post "jobs/#{id}/stop"
+    end
+
     def job_log(id)
       get_raw "jobs/#{id}/plain_logs.json"
     end
@@ -87,8 +109,7 @@ module Semaph
     def check_response(response, url)
       return response.body if response.status == 200
 
-      puts "http response #{response.status} received for #{url}:\n#{response.body}"
-      exit 1
+      raise RequestException.new(url, response)
     end
   end
 end

data/lib/semaph/commands.rb

@@ -0,0 +1,63 @@
+require "semaph/commands/reload_command"
+require "semaph/commands/rerun_workflow_command"
+require "semaph/commands/stop_workflow_command"
+require "semaph/commands/visit_url_command"
+
+module Semaph
+  module Commands
+    def self.workflow_commands(shell, workflow)
+      shell.add_command ::Semaph::Commands::RerunWorkflowCommand.new(workflow), "rerun"
+      shell.add_command ::Semaph::Commands::StopWorkflowCommand.new(workflow), "stop"
+      add_open_workflow_command(shell, workflow)
+      add_open_branch_command(shell, workflow)
+      add_github_commands(shell, workflow)
+    end
+
+    def self.add_open_workflow_command(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "https://#{workflow.project.client.host}/workflows/#{workflow.id}",
+          "browse to workflow",
+        ),
+        "open-workflow",
+      )
+    end
+
+    def self.add_open_branch_command(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "https://#{workflow.project.client.host}/branches/#{workflow.branch_id}",
+          "browse to branch in semaphore",
+        ),
+        "open-branch",
+      )
+    end
+
+    def self.add_github_commands(shell, workflow)
+      return unless workflow.project.github_url
+
+      add_github_branch(shell, workflow)
+      add_github_commit(shell, workflow)
+    end
+
+    def self.add_github_branch(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "#{workflow.project.github_url}/tree/#{workflow.branch}",
+          "browse to the branch in github",
+        ),
+        "open-github-branch",
+      )
+    end
+
+    def self.add_github_commit(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "#{workflow.project.github_url}/commit/#{workflow.sha}",
+          "browse to the commit in github",
+        ),
+        "open-github-commit",
+      )
+    end
+  end
+end

data/lib/semaph/commands/rerun_workflow_command.rb

@@ -1,5 +1,3 @@
-require "semaph/shells/workflow/workflow_shell"
-
 module Semaph
   module Commands
     class RerunWorkflowCommand

data/lib/semaph/commands/stop_workflow_command.rb

@@ -1,5 +1,3 @@
-require "semaph/shells/workflow/workflow_shell"
-
 module Semaph
   module Commands
     class StopWorkflowCommand

data/lib/semaph/formatting.rb

@@ -1,9 +1,27 @@
+require "rainbow"
+
 module Semaph
   module Formatting
-    TIME_FORMAT = "%Y-%m-%d %H:%M:%S".freeze
+    TIME_FORMAT = "%m-%d %H:%M".freeze
 
     def self.time(time)
       time.strftime(TIME_FORMAT)
     end
+
+    def self.hours_minutes_seconds(total_seconds)
+      seconds = total_seconds % 60
+      minutes = (total_seconds / 60) % 60
+      hours = total_seconds / (60 * 60)
+
+      format("%02<hours>d:%02<minutes>d:%02<seconds>d", hours: hours, minutes: minutes, seconds: seconds)
+    end
+
+    def self.index(number)
+      Rainbow(number.to_s.rjust(2)).yellow
+    end
+
+    def self.length(collection)
+      Rainbow(collection.length.to_s).cyan
+    end
   end
 end

data/lib/semaph/model/job.rb

@@ -1,3 +1,5 @@
+require "fileutils"
+
 module Semaph
   module Model
     class Job
@@ -20,8 +22,25 @@ module Semaph
         assign_from_block(raw_block)
       end
 
-      def log
-        pipeline.workflow.project.client.job_log(id)
+      def stop
+        pipeline.workflow.project.client.stop_job(id)
+      end
+
+      def show
+        pp pipeline.workflow.project.client.job(id)
+      end
+
+      def write_log(base)
+        FileUtils.mkdir_p(base)
+        filename = "#{base}/#{id}.log"
+        return filename if File.exist?(filename)
+
+        puts "retrieving log for job #{id}"
+        File.open(filename, "w") do |file|
+          file.puts pipeline.workflow.project.client.job_log(id)
+        end
+
+        filename
       end
 
       def description