semaph 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f49ea8741a162ab91ff18cb0b66618afe8eb462af876706b2d9707607f8c6be
-  data.tar.gz: cd248141014a077dfaa4f6e7a2ffc2a209e2f96b343986bef2dfcece3e681fdd
+  metadata.gz: 31aeabe99b27b7a10bc26f91c6a60e87e3374b309df5e41b8354694d99bd1a90
+  data.tar.gz: 34499279ff5fedb14739093655ad29ff703c9c3d40222208783106d73d746841
 SHA512:
-  metadata.gz: 7ebec8bbd45b6db77176c1e24934d5f5f7d50df018a00126d27b6fe3f5081768c9723e95cce8edab6ed8a0ad2d7abe1c1cacb9439b9343b68cfe6df03fa72408
-  data.tar.gz: f49f85257c58f82060c4082b59eb2d2b9698c2db8bd92188974c3f969620a73880e377ca7c8bb1b73aee3d02de2652bbdcfc37355047f0c119c399d1892c8ca7
+  metadata.gz: 47939331aee8435b5584f29ab39cf9647730dc0ead3b340c20175df3da849120aec5e9b97d3cd7dc116aa6044ac4fd9e1c4648b6ece862afe01a40b8e5007da9
+  data.tar.gz: 4f7b74225fd180ea85fad14c73a8a808733fc1d4836b69b99069a25314996bdd70066c1c1bb35b5e247cbeeefe5191760af50102d338e65992fdbd44ebfe529c

data/.gitignore

@@ -1,3 +1,6 @@
+.DS_Store
+*.log
+
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+

data/.semaphore/semaphore.yml

@@ -0,0 +1,23 @@
+version: v1.0
+name: "Main Build"
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+    
+auto_cancel:
+  queued:
+    when: true
+
+blocks:
+  - name: "Build"
+    task:
+      jobs:
+      - name: Build
+        commands:
+          - checkout
+          - 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/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/Gemfile

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in semaph.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    semaph (0.6.0)
+      faraday
+      rainbow
+      shell_shock
+
+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
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  rake (~> 12.0)
+  rubocop
+  semaph!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,28 +1,102 @@
 # Semaph
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/semaph`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is command line shell for interacting with [semaphoreci 2.0](http://docs.semaphoreci.com/).
+
+It complements the [sem](https://docs.semaphoreci.com/reference/sem-command-line-tool/) tool with some
+overlap in responsibilities.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    gem install semaph
+
+## Usage
+
+To set up authentication to semaphoreci, you can just follow the instructions to install and setup
+[sem](https://docs.semaphoreci.com/reference/sem-command-line-tool/).  This will result
+in your authentication details being written to `~/.sem.yaml`.
 
-```ruby
-gem 'semaph'
+You should see something like the following in this file:
+
+```yaml
+active-context: foo_semaphoreci_com
+contexts:
+  foo_semaphoreci_com:
+    auth:
+      token: qwerty
+    host: foo.semaphoreci.com
 ```
 
-And then execute:
+Now you can run `semaph` and will be presented with a prompt like one of the following:
 
-    $ bundle install
+     🏗  >
 
-Or install it yourself as:
+or
 
-    $ gem install semaph
+     🏗  foo.semaphoreci.com >
 
-## Usage
+This is the first of a series of nested shells.  Each shell represents a different context
+and has different commands available.  To see the commands available, execute `help` and
+to see the details of a particular command, execute `help <command name>`.  Once you are
+familar with the commands for each context, you can type the first couple of characters
+and then hit tab to complete the rest.  For some commands you can also tab complete the
+parameters. Once you enter a shell, return to the previous shell or exit `semaph`, you can
+press ctrl-d.
+
+### organisations shell
+
+     🏗  >
+
+You will only see this shell if you have multiple sets of credentials in your `~/.sem.yml` file.
+
+From this shell, you can `list-organisations` you are authenticated to and `select-organisation`
+to enter a shell for that organisation.
+
+### organisation shell
+
+     🏗  foo.semaphoreci.com >
+
+If you have only one set of credentials in `~/.sem.yml` then this will be the initial shell.
+
+From here you can `list-projects` and then `select-project` to enter a shell for that project.
+
+### project shell
+
+     🏗  foo.semaphoreci.com my-app >
+
+From this shell, you will mostly be interested in `list-workflows <branch>` (where 'branch' is any
+substring of the git branch you want to see workflows for) and then `select-workflow <index>`
+(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) and `open-project`
+(opens the semaphoreci project in a browser).
+
+### workflow shell
+
+    🏗  foo.semaphoreci.com my-app workflowuuid >
+
+From this shell, you can `list-pipelines` for the selected workflow.  These are the builds usually starting
+from `semaphore.yml` plus any promotion pipelines that might be executed.  You can `select-pipeline` to monitor
+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.
+
+### pipeline shell
+
+    🏗  foo.semaphoreci.com my-app workflowuuid semaphore.yml >
+
+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.
 
-TODO: Write usage instructions here
+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/exe/semaph

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "semaph"
+Semaph.console

data/lib/semaph.rb

@@ -1,6 +1,22 @@
 require "semaph/version"
+require "semaph/shells/organisations/organisations_shell"
+require "semaph/shells/organisation/organisation_shell"
+require "yaml"
 
 module Semaph
   class Error < StandardError; end
-  # Your code goes here...
+
+  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"]
+
+    if contexts.count == 1
+      Shells::Organisation::OrganisationShell.new(contexts.values.first).push
+    else
+      Shells::Organisations::OrganisationsShell.new(contexts).push
+    end
+  end
 end

data/lib/semaph/api.rb

@@ -0,0 +1,94 @@
+require "faraday"
+require "json"
+
+module Semaph
+  # Refer to https://docs.semaphoreci.com/reference/api-v1alpha/
+  class Api
+    attr_reader :host, :name
+
+    def initialize(token, host)
+      @token = token
+      @host = host
+      @name = host.split(".").first
+      @host_url = "https://#{host}"
+      @base = "#{@host_url}/api/v1alpha"
+    end
+
+    def projects
+      get "projects"
+    end
+
+    def workflows(project_id)
+      get "plumber-workflows", { project_id: project_id }
+    end
+
+    def workflow(workflow_id)
+      get "plumber-workflows/#{workflow_id}"
+    end
+
+    def stop_workflow(workflow_id)
+      post "plumber-workflows/#{workflow_id}/terminate"
+    end
+
+    def rerun_workflow(workflow_id)
+      post "plumber-workflows/#{workflow_id}/reschedule?request_token=#{workflow_id}"
+    end
+
+    def pipelines(options)
+      get "pipelines", options
+    end
+
+    def pipeline(id)
+      get "pipelines/#{id}", { detailed: true }
+    end
+
+    def job(id)
+      get "jobs/#{id}"
+    end
+
+    def job_log(id)
+      get_raw "jobs/#{id}/plain_logs.json"
+    end
+
+    private
+
+    def get_raw(path, params = {})
+      url = "#{@host_url}/#{path}"
+      puts url if ENV["SEMAPH_DEBUG"]
+      response = Faraday.get(url, params, { "Authorization" => "Token #{@token}" })
+      check_response(response, url)
+    end
+
+    def get(path, params = {})
+      url = "#{@base}/#{path}"
+      puts url if ENV["SEMAPH_DEBUG"]
+      response = Faraday.get(url, params, headers)
+      JSON.parse(check_response(response, url)).tap do |hash|
+        pp hash if ENV["SEMAPH_DEBUG"]
+      end
+    end
+
+    def post(path, params = {})
+      url = "#{@base}/#{path}"
+      response = Faraday.post(url, params.to_json, headers)
+      JSON.parse(check_response(response, url)).tap do |hash|
+        pp hash if ENV["SEMAPH_DEBUG"]
+      end
+    end
+
+    def headers
+      {
+        "Authorization" => "Token #{@token}",
+        "Content-Type" => "application/json",
+        "Accept" => "application/json",
+      }
+    end
+
+    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
+    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