hako-github_status 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05bc0b4478a4a4b107b11c9fd74a4aadc25b7a2b523783b992213525d376fd4e
+  data.tar.gz: 3be63c9e1612c03ecaa594594f0b8aaa29bc5696d4cc493d817ae630e001acc3
+SHA512:
+  metadata.gz: 71c30c92e4d16df4afd2ee6a86d8a8d18970f4fa8fc0cd48f2d745b422a10dd07dc4be112750199a68994547dcc8ddfd8aaca333b37428c7b1e2390b75bc4526
+  data.tar.gz: 0d5b1987a7fd5e009d952785dffc59c644416709e847ffbde6778cf507551472d05c7755d5fb02be40db3576c4df2c2d1fc80da0bbff74e3bf78e515266e78e4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hako-github_status.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    hako-github_status (0.0.1)
+      hako
+      jwt
+      octokit
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.269.0)
+    aws-sdk-applicationautoscaling (1.35.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-autoscaling (1.30.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-cloudwatch (1.32.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-cloudwatchlogs (1.28.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.89.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.137.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-ecs (1.57.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-elasticloadbalancing (1.19.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-elasticloadbalancingv2 (1.39.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-kms (1.28.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.60.1)
+      aws-sdk-core (~> 3, >= 3.83.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-servicediscovery (1.19.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sns (1.21.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-ssm (1.70.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    diff-lcs (1.3)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    hako (2.13.0)
+      aws-sdk-applicationautoscaling
+      aws-sdk-autoscaling
+      aws-sdk-cloudwatch
+      aws-sdk-cloudwatchlogs
+      aws-sdk-ec2
+      aws-sdk-ecs (>= 1.54.0)
+      aws-sdk-elasticloadbalancing
+      aws-sdk-elasticloadbalancingv2
+      aws-sdk-s3
+      aws-sdk-servicediscovery
+      aws-sdk-sns
+      aws-sdk-ssm
+      jsonnet
+    jmespath (1.4.0)
+    jsonnet (0.3.0)
+      mini_portile2 (>= 2.2.0)
+    jwt (2.2.1)
+    mini_portile2 (2.4.0)
+    multipart-post (2.1.1)
+    octokit (4.15.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (4.0.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hako-github_status!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sorah Fukumori
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# hako-github_status
+
+[hako](https://github.com/eagletmt/hako) script to update image tag of `app` container to the commit SHA of the latest check-succeeded commit in a specified GitHub repository and branch
+
+
+## Installation
+
+```ruby
+gem 'hako-github_status'
+```
+
+## Usage
+
+``` jsonnet
+{
+  scripts: [
+    {
+      type: 'github_status_tag',
+      repo: 'sorah/hello-container',
+      ref: 'master',
+      # at least either from checks or statuses must be set
+      checks: ['ci/circleci:build'], # Required status names on GitHub Checks API
+      statuses: ['legacy-ci'], # Required status contexts on GitHub Status API
+
+      client: {
+        access_token: 'your-access-token', # or environment variable $OCTOKIT_ACCESS_TOKEN
+        # login: 'github-login',
+        # password: 'github-password',
+        # api_endpoint: 'https://githubenterprise/api/v3/',
+        # web_endpoint: 'https://githubenterprise/',
+
+        # Or authenticating as a GitHub app
+        # github_app: { private_key: "... PEM ...", app_id: 123456 },
+      }
+    },
+  ],
+}
+```
+
+```
+hako deploy --tag github your-app.jsonnet
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hako-github_status.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hako/github_status"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hako-github_status.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/hako-github_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hako-github_status"
+  spec.version       = HakoGithubStatus::VERSION
+  spec.authors       = ["Sorah Fukumori"]
+  spec.email         = ["her@sorah.jp"]
+
+  spec.summary       = %q{Hako Script to update app image tag with GitHub commit status}
+  spec.homepage      = "https://github.com/sorah/hako-github_status"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hako"
+  spec.add_dependency "octokit"
+  spec.add_dependency "jwt"
+end

data/lib/hako-github_status/version.rb

@@ -0,0 +1,3 @@
+module HakoGithubStatus
+  VERSION = "0.0.1"
+end

data/lib/hako/scripts/github_status_tag.rb

@@ -0,0 +1,136 @@
+require 'hako/script'
+require 'octokit'
+
+module Hako
+  module Scripts
+    class GithubStatusTag < Script
+      class NoSuccessfulBuildError < StandardError; end
+
+      TARGET_TAG = 'github'
+
+      GITHUB_APP_MEDIA = 'application/vnd.github.machine-man-preview+json'
+      GITHUB_CHECKS_MEDIA = 'application/vnd.github.antiope-preview+json'
+
+      def configure(options)
+        super
+        @repo = options.fetch('repo')
+        @ref = options.fetch('ref', 'master')
+        @checks = options.fetch('checks', [])
+        @statuses = options.fetch('statuses ', [])
+        @client_options = options.fetch('client', {})
+
+        if @checks.empty? && @statuses.empty?
+          raise ArgumentError, "at least 1 check or 1 status must be set to github_status_tag script"
+        end
+      end
+
+      def deploy_starting(containers)
+        app = containers.fetch('app')
+        if app.definition['tag'] == TARGET_TAG
+          rewrite_tag(app)
+        end
+      end
+
+      alias_method :oneshot_starting, :deploy_starting
+
+      private
+
+      def rewrite_tag(app)
+        tag = fetch_version
+        app.definition['tag'] = tag
+        Hako.logger.info("Rewrite tag to #{app.image_tag}")
+      end
+
+      def fetch_version
+        page = octokit.commits(@repo, sha: @ref)
+        num_commits = 0
+
+        loop do
+
+          page.each do |commit|
+            num_commits += 1
+            ok = true
+            ok &&= @checks.empty? || (@checks - succeeded_checks_for_commit(commit[:sha])).empty?
+            ok &&= @statuses.empty? || (@statuses - succeeded_statuses_for_commit(commit[:sha])).empty?
+            return commit[:sha] if ok
+          end
+
+          next_page = octokit.last_response.rels[:next]&.href
+          raise NoSuccessfulBuildError unless next_page
+          Hako.logger.warn("github_status_tag is still finding a succeeding commit (num_commits=#{num_commits})")
+          sleep 1
+          page = octokit.get next_page
+        end
+      end
+
+      def succeeded_checks_for_commit(sha)
+        resp = octokit.check_runs_for_ref(@repo, sha, filter: 'completed', accept: GITHUB_CHECKS_MEDIA)
+        resp[:check_runs]
+          .select { |_| _[:status] == 'completed' && _[:conclusion] == 'success'}
+          .map{ |_| _[:name] }
+      end
+
+      def succeeded_statuses_for_commit(sha)
+        resp = octokit.combined_status(@repo, sha)
+        resp[:statuses]
+          .select{ |_| _[:state] == 'success' }
+          .map{ |_| _[:context] }
+      end
+
+      def octokit
+        @octokit ||= if @client_options['github_app']
+                       repo_octokit
+                     else
+                       Octokit::Client.new(octokit_options)
+                     end
+      end
+
+      def repo_octokit
+        @octokit ||= Octokit::Client.new(
+          octokit_options.merge(
+            access_token: github_installation_token,
+          )
+        )
+      end
+
+      def octokit_options
+        {}.tap do |o|
+          o[:web_endpoint] = @client_options['web_endpoint'] if @client_options['web_endpoint']
+          o[:api_endpoint] = @client_options['api_endpoint'] if @client_options['api_endpoint']
+          o[:login] = @client_options['login'] if @client_options['login']
+          o[:password] = @client_options['password'] if @client_options['password']
+          o[:access_token] = @client_options['access_token'] if @client_options['access_token']
+        end
+      end
+
+      def app_octokit
+        @app_octokit ||= Octokit::Client.new(
+          octokit_options.merge(
+            bearer_token: github_jwt,
+          )
+        )
+      end
+
+      def github_installation_token
+        return @github_installation_token if defined? @github_installation_token
+
+        installation = app_octokit.find_repository_installation(@repo, accept: GITHUB_APP_MEDIA)
+        raise "no github app installation found for #{repo.name.inspect}" unless installation
+
+        issuance = app_octokit.create_app_installation_access_token(installation[:id], accept: GITHUB_APP_MEDIA)
+        @github_installation_token = issuance[:token]
+      end
+
+      def github_jwt
+        iat = Time.now.to_i
+        payload = {
+          iss: @client_options['github_app'].fetch('id'),
+          iat: iat,
+          exp: iat + (3*60),
+        }
+        JWT.encode(payload, @client_options['github_app'].fetch('id'), 'RS256')
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: hako-github_status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sorah Fukumori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hako
+  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: octokit
+  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: jwt
+  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: 
+email:
+- her@sorah.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hako-github_status.gemspec
+- lib/hako-github_status/version.rb
+- lib/hako/scripts/github_status_tag.rb
+homepage: https://github.com/sorah/hako-github_status
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sorah/hako-github_status
+  source_code_uri: https://github.com/sorah/hako-github_status
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Hako Script to update app image tag with GitHub commit status
+test_files: []