pipedawg 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da632acfefa54ce858d4277758160be20246355596f84a5cf7f7a47c6bf7f93
-  data.tar.gz: 52c803810e345742b2ae1f0ff10e19e3afd5a8423164667346fcda75d78b54ee
+  metadata.gz: b1df968015369cc666fc521d546b3194e82f04ec28b9a2473dbc2452b5c37780
+  data.tar.gz: 5afe211e7fb69ac10808af059e02dc5706c882ad86d2309901d2f943e0ec6a6d
 SHA512:
-  metadata.gz: 3aa2f038cabfca9659ac80cc1c04a186d3ffed3d5dac47e3ab64140f09d1c5dfecba9d41c59e90e7215dab99edad8aeff8a3f2162b11b88b42551fe88ace12e8
-  data.tar.gz: 758697c43505ff847d74e3c5db85417652636dda97082b444ef975752dd03cd0853d6cc78b9403c9ecf11894510daf5ded82edeab7bb7b1e99b9441ec28b207b
+  metadata.gz: 7348909008c56e40d693f388da3b6eb8210c380a357c87c5e1cf906932a9c66246af77a9328f0746d70b2213943c95f73256d835b5163ca17348a9068998a5ac
+  data.tar.gz: 9f3b4d44c1e2e5e2b955ecd135ccdcfd100d15fbcc137f40dca0af2797a0aa3637444e2e75ec910ac428a953147d883ecb24414c6e10bba17dfb0d40f3881b70

data/README.md

@@ -1,10 +1,18 @@
-# Pipedawg
+# pipedawg
+
+[![Gem Version](https://badge.fury.io/rb/pipedawg.svg)](https://rubygems.org/gems/pipedawg)
 
 Generate GitLab CI pipelines.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install `pipedawg` with:
+
+```
+gem install pipedawg
+```
+
+Or add this line to your application's Gemfile:
 
 ```ruby
 gem 'pipedawg'
@@ -12,25 +20,90 @@ gem 'pipedawg'
 
 And then execute:
 
-    $ bundle install
+```sh
+bundle install
+```
 
-Or install it yourself as:
+## Ruby library
 
-    $ gem install pipedawg
+Example:
 
-## Usage
+```ruby
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# print_pipeline.rb
+require 'pipedawg'
+
+gem_job = Pipedawg::Job.new(
+  'build:gem',
+  artifacts: ['*.gem'],
+  image: 'ruby',
+  script: ['bundle install', 'gem build *.gemspec']
+)
+
+kaniko_job = Pipedawg::KanikoJob.new(
+  'build:kaniko',
+  {needs: ['build:gem'], retry: 2},
+  {context:'${CI_PROJECT_DIR}/docker',external_files: {'*.gem':'gems'}}
+)
+
+pipeline = Pipedawg::Pipeline.new 'build:image', jobs: [gem_job, kaniko_job]
+puts pipeline.to_yaml
+```
 
+```console
+$ chmod +x print_pipeline.rb
+$ ./print_pipeline.rb
+---
+stages:
+- '1'
+- '2'
+workflow: {}
+build:gem:
+  artifacts:
+  - "*.gem"
+  cache: {}
+  image: ruby
+  needs: []
+  rules: []
+  script:
+  - bundle install
+  - gem build *.gemspec
+  stage: '1'
+  tags: []
+build:kaniko:
+  artifacts: {}
+  cache: {}
+  needs:
+  - build:gem
+  retry: 2
+  rules: []
+  script:
+  - echo "{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}"
+    > "/kaniko/.docker/config.json"
+  - cp "*.gem" "${CI_PROJECT_DIR}/docker/gems"
+  - '"/kaniko/executor" --context "${CI_PROJECT_DIR}/docker" --dockerfile "Dockerfile"
+    --no-push'
+  stage: '2'
+  tags: []
+```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. Run `bundle exec rubocop` to run the linter. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Note that by default, Bundler will attempt to install gems to the system, e.g. `/usr/bin`, `/usr/share`, which requires elevated access and can interfere with files that are managed by the system's package manager. This behaviour can be overridden by creating the file `.bundle/config` and adding the following line:
+```
+BUNDLE_PATH: "./.bundle"
+```
+When you run `bin/setup` or `bundle install`, all gems will be installed inside the .bundle directory of this project.
 
-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).
+To make this behaviour a default for all gem projects, the above line can be added to the user's bundle config file in their home directory (`~/.bundle/config`)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/liger1978/pipedawg.
-
+Bug reports and pull requests are welcome on [GitHub](https://github.com/liger1978/pipedawg).
 
 ## License
 

data/lib/pipedawg/job.rb

@@ -13,7 +13,7 @@ module Pipedawg
         image: { name: 'ruby:2.5' },
         needs: [],
         retry: nil,
-        rules: [],
+        rules: nil,
         script: [],
         stage: 'build',
         tags: []

data/lib/pipedawg/kaniko_job.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Pipedawg
+  # kaniko_job class
+  class KanikoJob < Job
+    attr_accessor :kaniko_opts
+
+    def initialize(name = 'build', opts = {}, kaniko_opts = {}) # rubocop:disable Metrics/MethodLength
+      @kaniko_opts = {
+        build_args: {},
+        config: {
+          '$CI_REGISTRY': {
+            username: '$CI_REGISTRY_USER',
+            password: '$CI_REGISTRY_PASSWORD'
+          }
+        },
+        config_file: '/kaniko/.docker/config.json',
+        context: '${CI_PROJECT_DIR}',
+        destinations: [],
+        dockerfile: 'Dockerfile',
+        executor: '/kaniko/executor',
+        external_files: {},
+        flags: [],
+        ignore_paths: [],
+        insecure_registries: [],
+        kaniko_image: {
+          entrypoint: [''],
+          name: 'gcr.io/kaniko-project/executor:debug'
+        },
+        options: {},
+        registry_certificates: {},
+        registry_mirrors: [],
+        skip_tls_verify_registry: [],
+        trusted_ca_cert_source_files: [],
+        trusted_ca_cert_target_file: '/kaniko/ssl/certs/ca-certificates.crt'
+      }.merge(kaniko_opts)
+      super name, opts
+      update
+    end
+
+    def update # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      require 'json'
+      opts[:image] = kaniko_opts[:image]
+      script = ["echo #{kaniko_opts[:config].to_json.inspect} > \"#{kaniko_opts[:config_file]}\""]
+      cert_copies = Array(kaniko_opts[:trusted_ca_cert_source_files]).map do |cert|
+        "cat \"#{cert}\" >> \"#{kaniko_opts[:trusted_ca_cert_target_file]}\""
+      end
+      script.concat cert_copies
+      file_copies = kaniko_opts[:external_files].map do |source, dest|
+        "cp \"#{source}\" \"#{kaniko_opts[:context]}/#{dest}\""
+      end
+      script.concat file_copies
+      flags = kaniko_opts[:flags].clone
+      flags << 'no-push' if kaniko_opts[:destinations].empty?
+      flags_cli = flags.uniq.map { |f| "--#{f}" }.join(' ')
+      options_cli =  kaniko_opts[:options].map { |k, v| "--#{k}=\"#{v}\"" }.join(' ')
+      build_args_cli = kaniko_opts[:build_args].map { |k, v| "--build-arg #{k}=\"#{v}\"" }.join(' ')
+      ignore_paths_cli = Array(kaniko_opts[:ignore_paths]).map { |p| "--ignore-path #{p}" }.join(' ')
+      insecure_registries_cli = Array(kaniko_opts[:insecure_registries]).map do |r|
+        "--insecure-registry #{r}"
+      end.join(' ')
+      registry_certificates_cli = kaniko_opts[:registry_certificates].map do |k, v|
+        "--registry-certificate #{k}=\"#{v}\""
+      end.join(' ')
+      registry_mirrors_cli = Array(kaniko_opts[:registry_mirrors]).map { |r| "--registry-mirror #{r}" }.join(' ')
+      skip_tls_verify_registrys_cli = Array(kaniko_opts[:skip_tls_verify_registry]).map do |r|
+        "--skip-tls-verify-registry #{r}"
+      end.join(' ')
+      destinations_cli = kaniko_opts[:destinations].map { |d| "--destination #{d}" }.join(' ')
+      kaniko_cmds = [
+        "\"#{kaniko_opts[:executor]}\"",
+        '--context',
+        "\"#{kaniko_opts[:context]}\"",
+        '--dockerfile',
+        "\"#{kaniko_opts[:dockerfile]}\"",
+        flags_cli,
+        options_cli,
+        build_args_cli,
+        ignore_paths_cli,
+        insecure_registries_cli,
+        registry_certificates_cli,
+        registry_mirrors_cli,
+        destinations_cli,
+        skip_tls_verify_registrys_cli
+      ].reject(&:empty?)
+      script << kaniko_cmds.join(' ')
+      opts[:script] = script
+    end
+  end
+end

data/lib/pipedawg/pipeline.rb

@@ -10,8 +10,9 @@ module Pipedawg
       @opts = {
         jobs: [Pipedawg::Job.new],
         stages: ['build'],
-        workflow: {}
+        workflow: nil
       }.merge(opts)
+      update
     end
 
     def to_yaml
@@ -24,11 +25,11 @@ module Pipedawg
       JSON.parse(pipeline.to_json).to_yaml
     end
 
-    def to_yaml_file(file = '.gitlab-ci.yml')
+    def to_yaml_file(file = 'pipeline.yml')
       File.write(file, to_yaml)
     end
 
-    def update_stages
+    def update
       stages = []
       opts[:jobs].each do |job|
         stage = stage_from_needs(opts[:jobs], job.name)

data/lib/pipedawg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pipedawg
-  VERSION = '0.1.0'
+  VERSION = '0.2.2'
 end

data/lib/pipedawg.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'pipedawg/job'
+require 'pipedawg/kaniko_job'
 require 'pipedawg/pipeline'
 require 'pipedawg/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pipedawg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - harbottle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies: []
 description: Generate GitLab CI pipelines.
 email:
@@ -17,21 +17,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundle/config"
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/pipedawg.rb
 - lib/pipedawg/job.rb
+- lib/pipedawg/kaniko_job.rb
 - lib/pipedawg/pipeline.rb
 - lib/pipedawg/version.rb
-- pipedawg.gemspec
 homepage: https://github.com/liger1978/pipedawg
 licenses:
 - MIT
@@ -54,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Generate GitLab CI pipelines.

data/.bundle/config

@@ -1,4 +0,0 @@
----
-BUNDLE_BIN: "bin"
-BUNDLE_DISABLE_SHARED_GEMS: "true"
-BUNDLE_PATH: "./bundle"

data/.gitignore

@@ -1,15 +0,0 @@
-/bin/
-/bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/*.gem
-/vendor
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status

data/.gitlab-ci.yml

@@ -1,14 +0,0 @@
----
-stages:
-- build
-workflow: {}
-build:
-  artifacts: {}
-  cache: {}
-  image:
-    name: ruby:2.5
-  needs: []
-  rules: []
-  script: []
-  stage: build
-  tags: []

data/.rspec

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

data/.rubocop.yml

@@ -1,14 +0,0 @@
----
-AllCops:
-  Exclude:
-    - 'bin/**/*'
-    - 'bundle/**/*'
-    - '*.gemspec'
-  NewCops: enable
-
-Metrics/BlockLength:
-  Exclude:
-    - 'Rakefile'
-    - '**/*.rake'
-    - 'test/**/*.rb'
-    - 'spec/**/*_spec.rb'

data/.travis.yml

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

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in pipedawg.gemspec
-gemspec
-
-gem 'irb', '~> 1.4'
-gem 'rake', '~> 12.0'
-gem 'rdoc', '~> 6.4'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.24', require: false
-gem 'rubocop-rake', '~> 0.6', require: false
-gem 'rubocop-rspec', '~> 2.7', require: false

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/pipedawg.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/pipedawg/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'pipedawg'
-  spec.version       = Pipedawg::VERSION
-  spec.authors       = ['harbottle']
-  spec.email         = ['harbottle@room3d3.com']
-
-  spec.summary       = 'Generate GitLab CI pipelines.'
-  spec.description   = 'Generate GitLab CI pipelines.'
-  spec.homepage      = 'https://github.com/liger1978/pipedawg'
-  spec.license       = 'MIT'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/liger1978/pipedawg'
-  spec.metadata['changelog_uri'] = 'https://github.com/liger1978/pipedawg'
-
-  # 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(__dir__)) 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']
-
-end