gha_config 0.10 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d19ff5b1e9e5061ace6d37d397e5e7404525d6ce101b74cb9532db251d30b4
-  data.tar.gz: '09ec807d50a2b8c55e50ddc0691a577458a0a62967d540f67402e0c38b39a87a'
+  metadata.gz: cb2d82c82325e3c26d5f4163f8eada040efa9060761ea1aa815645be44644326
+  data.tar.gz: 884c6e758132c49edb32aa64b438c41f9647782f3949ebe5e034a64e1d281176
 SHA512:
-  metadata.gz: d7973193d71d199bf15c9a858e7ab307fe6e6f58d606acdeb26127906f7f1125cf102236f9b62ecfcdb38fbc25548cfce640e33edd6318d1048235de1b9019f3
-  data.tar.gz: cfc3111a028a9bb696b51030aa66b9ccc62146153d312b31bc98f19114b3a18a8e432ad2f68347f09f6a433019aeab613b9bd06d66f8385dd91fca9e12bfb77f
+  metadata.gz: d086bec6a7a35df73466318ea33866ec1d1997353ab16d59e560aede723da1ea78e0f11c444b8730550287463a6fa34731ebc5b896b88bf1dca97f2d8c85744b
+  data.tar.gz: a86fb656b87c140425c7a735c00679815fe101f58741f066f29457ae7a3a4091be60edab580c6bd46840ef3c56ccbf38b51f7007346611dd060b4c718832bd57

data/.github/workflow-src

@@ -0,0 +1,7 @@
+prod_branch: main
+ci_image: ruby-2.6-stretch
+mysql: false
+kafka: false
+datadog: false
+redis: false
+

data/.github/workflows/CI.yml

@@ -0,0 +1,68 @@
+name: CI
+
+on: push
+
+env:
+  HOME: /home/circleci
+  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+  AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
+  AWS_REGION: ${{ secrets.AWS_REGION }}
+  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+  DEPLOYMENT_TYPE: ${{ secrets.DEPLOYMENT_TYPE }}
+  ECR_REPOSITORY: ${{ secrets.ECR_REPOSITORY }}
+  ECS_CLUSTER_PROD: ${{ secrets.ECS_CLUSTER_PROD }}
+  ECS_CLUSTER_STG: ${{ secrets.ECS_CLUSTER_STG }}
+  ECS_SERVICE_PROD: ${{ secrets.ECS_SERVICE_PROD }}
+  ECS_SERVICE_STG: ${{ secrets.ECS_SERVICE_STG }}
+  SERVICE_NAME: ${{ secrets.SERVICE_NAME }}
+  SERVICE_PROFILE: ${{ secrets.SERVICE_PROFILE }}
+  SERVICE_TOKEN: ${{ secrets.SERVICE_TOKEN }}
+  WISHABI_ENVIRONMENT: ${{ secrets.WISHABI_ENVIRONMENT }}
+
+jobs:
+  build:
+    runs-on: [ubuntu, runner-fleet]
+    container:
+      image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster
+      credentials:
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GHCR_TOKEN }}
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Bundle cache
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: rails-{{ arch }}-{{ checksum "Gemfile.lock" }}
+        restore-keys: rails-{{ arch }}-
+    - name: Bundle install
+      run: |
+        sudo chmod 1777 -R /home/circleci/.bundle && bundle config path 'vendor/bundle' && bundle install --jobs=4
+
+  deploy-gem:
+    runs-on: [ubuntu, runner-fleet]
+    needs: [build]
+    container:
+      image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster
+      credentials:
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GHCR_TOKEN }}
+    if: github.ref == 'refs/heads/main'
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Bundle cache
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: rails-{{ arch }}-{{ checksum "Gemfile.lock" }}
+        restore-keys: rails-{{ arch }}-
+    - name: Bundle install
+      run: |
+        sudo chmod 1777 -R /home/circleci/.bundle && bundle config path 'vendor/bundle' && bundle install --jobs=4
+    - name: Deploy to production
+      run: |
+        chmod +x ./deploy/artifactory.sh && ./deploy/artifactory.sh
+

data/.gitignore

@@ -0,0 +1,41 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/log/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+test.sqlite3
+
+.idea

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  flipp_ruby_style: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/Documentation:
+  Exclude:
+    - 'lib/gha_config/step_definitions/**/*'
+    - 'lib/gha_config/workflows/**/*'
+
+Style/DocumentationMethod:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.15] - 2021-07-27
+- Fix bug where defaults are not given (uses [] instead of {})
+
+## [0.14] - 2021-07-22
+- Update global action to v0.4
+
+## [0.13] - 2021-07-19
+- Fixes related to global action
+
+## [0.11] - 2021-07-15
+- First public version.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://flipplib.jfrog.io/flipplib/api/gems/flipp-gems/'
+
+# Specify your gem's dependencies in boilerplate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    gha_config (0.14)
+
+GEM
+  remote: https://flipplib.jfrog.io/flipplib/api/gems/flipp-gems/
+  specs:
+    ast (2.4.2)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (0.90.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gha_config!
+  rubocop
+
+BUNDLED WITH
+   2.2.21

data/README.md

@@ -4,7 +4,7 @@ This gem will process a templated file and output a GitHub Action workflow file
 
 ## Installation
 
-You will need Ruby 2.3 or greater to run this (most Macs have this preinstalled). Make sure you have the latest version of Rubygems as well.
+You will need Ruby 2.3 or greater to run this (you can install this via Homebrew if you don't have it). Make sure you have the latest version of Rubygems as well.
 
 Install using `gem install gha_config`.
 
@@ -23,7 +23,7 @@ Template keys are very similar to [YAML anchors](http://blogs.perl.org/users/tin
 
 Template keys all begin and end with underscores: `_`. You define template keys in a special `_defaults_` section in your config, and you can use them elsewhere.
 
-Here's an example of a templated GitHub Action workflow file:
+Here's an example of a templated GitHub Action workflow file.
 
 ```yaml
 on:
@@ -33,7 +33,7 @@ on:
     - master
     - develop
 
-defaults_:
+_defaults_:
   _container_:
     image: ghcr.io/wishabi/ci-build-environment:ruby-3.0-buster-node
     credentials:
@@ -47,11 +47,8 @@ defaults_:
         key: rails-${{ hashFiles('Gemfile.lock') }}
         restore-keys: rails-
   _teardown_:
-    - name: Slack webhook
-      env:
-        SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
-      uses: voxmedia/github-action-slack-notify-build@v2
-      if: failure()
+    - name: Cleanup
+    - run: docker cleanup
   _setup_:
     - _cache_
     - name: Bundle install
@@ -62,10 +59,13 @@ jobs:
     container: _container_
     steps:
       - _setup_
+      - name: Print build
+        run: ls dist/
       - _teardown_
 ```
 
-The output of this file will look like this:
+The output of this file will look like this (you can see that it auto-creates the checkout and "Flipp global" steps):
+
 ```yaml
 name: CI
 
@@ -105,6 +105,14 @@ jobs:
     steps:
     - name: Checkout code
       uses: actions/checkout@v2
+    - name: Flipp global
+      uses: wishabi/github-actions@v0.3
+      env:
+        SLACK_BOT_TOKEN: "${{ secrets.SLACK_BOT_TOKEN }}"
+      timeout-minutes: 10
+      with:
+        slack_channel: "${{env.SLACK_CHANNEL }}"
+        job_status: "${{ job.status }}"
     - name: Bundle cache
       uses: actions/cache@v2
       with:
@@ -113,18 +121,15 @@ jobs:
         restore-keys: rails-
     - name: Bundle install
       run: bundle install --jobs=4
-    - name: Slack webhook
-      env:
-        SLACK_BOT_TOKEN: "${{ secrets.SLACK_BOT_TOKEN }}"
-      uses: voxmedia/github-action-slack-notify-build@v2
-      if: failure()
+    - name: Print build
+      run: ls dist/
+    - name: Cleanup
+      run: docker cleanup
 ```
 
-In the future, we will likely auto-add the Flipp "global action" to each job once it's created.
-
-Templates get expanded into their contents whenever they are used. Templates can also include templates (as you can see that the `setup` template includes the `cache` template). Finally, if a template is used inside a list of steps, the expansion will continue the list rather than nest it.
+Templates get expanded into their contents whenever they are used. Templates can also include templates (as you can see that the `_setup_` template includes the `_cache_` template). Finally, if a template is used inside a list of steps, the expansion will continue the list rather than nest it.
 
-You can add this gem to your app Gemfile and re-run it whenever your "source workflow" changes.
+If you're using Ruby, you can add this gem to your app Gemfile. Otherwise, you can install it locally. Either way, you can re-run it whenever your "source workflow" changes.
 
 ## Contributing
 

data/bin/gha_config

@@ -0,0 +1,19 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yaml'
+require 'active_support/all'
+require 'fileutils'
+
+require_relative '../lib/gha_config/parser'
+require_relative '../lib/gha_config/writer'
+require_relative '../lib/gha_config/config'
+
+file = ARGV[1] || '.github/workflow-src/CI.yml'
+unless File.exist?(file)
+  puts "File #{file} does not exist!"
+  exit(1)
+end
+results = GhaConfig::Parser.parse(file)
+GhaConfig::Writer.write(results, '.github/workflows/CI.yml')
+puts "Wrote results to .github/workflows/CI.yml"

data/gha_config.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gha_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gha_config'
+  spec.version       = GhaConfig::VERSION
+  spec.authors       = ['Daniel Orner']
+  spec.email         = ['daniel.orner@flipp.com']
+  spec.summary       = 'Process GitHub Action workflow files'
+  spec.description   = 'Write a longer description. Optional.'
+  spec.homepage      = ''
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('rubocop')
+end

data/lib/gha_config.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module GhaConfig
+end

data/lib/gha_config/config.rb

@@ -0,0 +1,13 @@
+module GhaConfig
+  class Config
+    attr_accessor :defaults
+    attr_accessor :env
+    attr_accessor :parsed_config
+
+    def initialize
+      @env = {}
+      @defaults = []
+      @parsed_config = {}
+    end
+  end
+end

data/lib/gha_config/parser.rb

@@ -0,0 +1,36 @@
+require 'byebug'
+
+module GhaConfig
+  module Parser
+    def self.parse(input_file)
+      input = File.read(input_file)
+      input.gsub!(/(^|\n)on:/, %(\n"on":))
+      hash = YAML.safe_load(input)
+      config = GhaConfig::Config.new
+      config.defaults = hash.delete('_defaults_') || {}
+      config.env = hash.delete('env') || {}
+
+      hash['jobs'] = replace_defaults(config, hash['jobs'])
+      config.parsed_config = hash
+      config
+    end
+
+    def self.replace_defaults(config, hash)
+      if hash.is_a?(Array)
+        return hash.map { |v| self.replace_defaults(config, v)}.compact.flatten
+      elsif hash.is_a?(Hash)
+        return hash.map { |k, v| [k, self.replace_defaults(config, v)] }.to_h
+      end
+      return hash unless hash.is_a?(String) && hash =~ /_.*_/
+      return hash unless config.defaults.key?(hash)
+      val = config.defaults[hash]
+      if val.is_a?(Array)
+        val.map { |v| self.replace_defaults(config, v) }.flatten
+      else
+        self.replace_defaults(config, val)
+      end
+
+    end
+
+  end
+end

data/lib/gha_config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GhaConfig
+  VERSION = '0.15'
+end

data/lib/gha_config/writer.rb

@@ -0,0 +1,83 @@
+module GhaConfig
+  module Writer
+    def self.write(config, output_file)
+      output_hash = {}
+      output_hash['name'] = 'CI'
+      output_hash['on'] = config.parsed_config['on']
+
+      default_env =  {
+        'SLACK_CHANNEL' => ''
+      }
+      output_hash['env'] = default_env.merge(config.env).
+        merge({
+                'HOME'                  => '/home/circleci',
+                'AWS_ACCESS_KEY_ID'     => '${{ secrets.AWS_ACCESS_KEY_ID }}',
+                'AWS_ACCOUNT_ID'        => '${{ secrets.AWS_ACCOUNT_ID }}',
+                'AWS_REGION'            => '${{ secrets.AWS_REGION }}',
+                'AWS_SECRET_ACCESS_KEY' => '${{ secrets.AWS_SECRET_ACCESS_KEY }}',
+                'DEPLOYMENT_TYPE'       => '${{ secrets.DEPLOYMENT_TYPE }}',
+                'ECR_REPOSITORY'        => '${{ secrets.ECR_REPOSITORY }}',
+                'ECS_CLUSTER_PROD'      => '${{ secrets.ECS_CLUSTER_PROD }}',
+                'ECS_CLUSTER_STG'       => '${{ secrets.ECS_CLUSTER_STG }}',
+                'ECS_SERVICE_PROD'      => '${{ secrets.ECS_SERVICE_PROD }}',
+                'ECS_SERVICE_STG'       => '${{ secrets.ECS_SERVICE_STG }}',
+                'SERVICE_NAME'          => '${{ secrets.SERVICE_NAME }}',
+                'SERVICE_PROFILE'       => '${{ secrets.SERVICE_PROFILE }}',
+                'SERVICE_TOKEN'         => '${{ secrets.SERVICE_TOKEN }}',
+                'WISHABI_ENVIRONMENT'   => '${{ secrets.WISHABI_ENVIRONMENT }}'
+              })
+
+      output_hash['jobs'] = {}
+      config.parsed_config['jobs'].each do |name, job|
+        new_job = {
+          'runs-on' => '[ubuntu, runner-fleet]'
+        }
+        job['runs-on'] = '[ubuntu, runner-fleet]'
+        job['steps'].unshift({
+                                'name' => 'Flipp global',
+                                'uses' => 'wishabi/github-actions@v0.4',
+                                'env' => {
+                                  'SLACK_BOT_TOKEN' => "${{ secrets.SLACK_BOT_TOKEN }}"
+                                },
+                                'timeout-minutes' => 10,
+                                'with' => {
+                                  'slack_channel' => '${{env.SLACK_CHANNEL }}',
+                                  'job_status' => '${{ job.status }}'
+                                }})
+        job['steps'].unshift({
+                               'name' => 'Checkout code',
+                               'uses' => 'actions/checkout@v2'
+                             })
+        job['needs'] = "[#{job['needs'].join(', ')}]" if job['needs'].is_a?(Array)
+        new_job.merge!(job)
+        output_hash['jobs'][name] = new_job
+      end
+      output = output_hash.to_yaml
+      output = cleanup(output)
+      header = <<-OUT
+######## GENERATED FROM ./github/workflow-src/CI.yml
+######## USING gha_config https://github.com/wishabi/gha-config
+
+      OUT
+      output = header + output
+      File.write(output_file, output)
+    end
+
+    def self.cleanup(out)
+      out = out.sub("---\n", '')
+      out = out.gsub(/'on'/, 'on') # replace 'on' with on
+      out = out.gsub(/: ''/, ':') # replace : '' with :
+      out = out.gsub(/\n(\S)/) { "\n\n#{$1}" } # add empty line before top level keys
+      out = out.gsub(/"\[/, '[')
+      out = out.gsub(/\]"/, ']') # change "[...]" to [...]
+
+      first, last = out.split("\njobs:")
+      first = first.gsub(/"/, '') # remove quotes from env block
+      last = last.gsub(/\n  (\S)/) { "\n\n  #{$1}" } # add empty line before job keys
+      out = first + "\njobs:" + last
+
+      out
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gha_config
 version: !ruby/object:Gem::Version
-  version: '0.10'
+  version: '0.15'
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -27,11 +27,27 @@ dependencies:
 description: Write a longer description. Optional.
 email:
 - daniel.orner@flipp.com
-executables: []
+executables:
+- gha_config
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflow-src"
+- ".github/workflows/CI.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - README.md
+- bin/gha_config
+- gha_config.gemspec
+- lib/gha_config.rb
+- lib/gha_config/config.rb
+- lib/gha_config/parser.rb
+- lib/gha_config/version.rb
+- lib/gha_config/writer.rb
 homepage: ''
 licenses: []
 metadata: {}