service_image_builder 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c8262a35662d3f437f013c16b2bc07e3a2cb2d2134540dc29f5f1658d86fbbd
-  data.tar.gz: 958a2d6ae6b05a5cb4d861c367e00e783914c9061fcba49111fd776d59da62f8
+  metadata.gz: 900269f5179222514b60a9801fcb2185eca190de7549de06f0c3581acfed50a9
+  data.tar.gz: '0395906fef0ff745d19954216b22ee62afe597d52b8d6a1389cab9228f006b38'
 SHA512:
-  metadata.gz: be9f00f831944d7692aa22a518c10ccfca329a9e1d11bcfb6fe9bd86bf139cb795f225b7925d5de28f3755d65fdc915aaa293c8c1ea38b651dbac833a13a05a2
-  data.tar.gz: df803efdb83c06d8b608f875cc1278af0888185f6c9464c75aaf747bb0d9633627c19be8c78eaaa317eec9676e236e493a8935663bdcfa27104bf1ac50de12b4
+  metadata.gz: ae08276865478e406ba0982559f8dcf8d02201b03067d54476db6360ccca516408d6f01d3b2280cf968aa3b3bcfe04bdb1663c8f58f5ab8dfb6be16f06b220cb
+  data.tar.gz: 1e505048f31b20719cf88505c1e5d49c877dd4bbf1bd171aa979d141c35a9c392b9c09e54dd08ef21f10ac7c1c7c288945216ec39907ad835d693c98a972b416

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/Dockerfile

@@ -1,3 +1,5 @@
 FROM slushsystems/ruby:latest
 
+USER root
 RUN gem install service_image_builder
+USER slushy

data/Gemfile.lock

@@ -1,19 +1,23 @@
 PATH
   remote: .
   specs:
-    service_image_builder (0.1.2)
+    service_image_builder (0.1.3)
       activesupport (~> 5.2)
+      awesome_print (~> 1.8)
       docker-api (~> 1.34)
+      logger (~> 1.4, >= 1.4.2)
+      oj (~> 3.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (5.2.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.0)
+    awesome_print (1.8.0)
     byebug (11.0.1)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
@@ -21,13 +25,15 @@ GEM
     docker-api (1.34.2)
       excon (>= 0.47.0)
       multi_json
-    excon (0.64.0)
-    i18n (1.6.0)
+    excon (0.71.1)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
+    logger (1.4.2)
     method_source (0.9.2)
-    minitest (5.11.3)
-    multi_json (1.13.1)
+    minitest (5.13.0)
+    multi_json (1.14.1)
+    oj (3.10.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
@@ -61,7 +67,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
 
@@ -77,4 +83,4 @@ DEPENDENCIES
   service_image_builder!
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -7,10 +7,13 @@ registry.
 
 SIB is configured through environment variables:
 
-- CI_COMMIT_SHA — Automatically provided by gitlab CI; commit sha from source control; # TODO pick this up from VCS directly if unset
+- CI_COMMIT_SHA — Automatically provided by gitlab CI; commit sha from source
+    control; # TODO pick this up from VCS directly if unset
 - SIB_BUILD_DIR — Docker build context directory; optional & defaults to $PWD
-- SIB_DOCKER_FILE — Dockerfile to use in build; optional & defaults to 'Dockerfile'
+- SIB_DOCKER_FILE — Dockerfile to use in build; optional & defaults to
+    'Dockerfile'
 - SIB_IMAGE_REPO — *required* Docker repo
 - SIB_REGISTRY_USER — *required* Username to authenticate with the registry
 - SIB_REGISTRY_PASS — *required* Password to authenticate with the registry
-- SIB_UPSTREAM_TAG — Upstream tag to compare against and push to; optional & defaults to 'latest'
+- SIB_UPSTREAM_TAG — Upstream tag to compare against and push to; optional &
+    defaults to 'latest'

data/bin/sib

@@ -16,7 +16,7 @@ require_relative '../lib/service_image_builder.rb'
 
 build_dir = ENV.fetch('SIB_BUILD_DIR', '.')
 current_commit_id = ENV.fetch('CI_COMMIT_SHA')
-docker_file = ENV.fetch('SIB_DOCKER_FILE', 'Dockerfile')
+dockerfile = ENV.fetch('SIB_DOCKER_FILE', 'Dockerfile')
 image_repo = ENV.fetch('SIB_IMAGE_REPO')
 image_upstream_tag = ENV.fetch('SIB_UPSTREAM_TAG', 'latest')
 registry_pass = ENV.fetch('SIB_REGISTRY_PASS')
@@ -25,31 +25,23 @@ squash = ENV.fetch('SIB_SQUASH', false)
 
 Docker.authenticate!('username' => registry_user, 'password' => registry_pass)
 
-upstream_docker_image = begin
-  Docker::Image.create('fromImage' => "#{image_repo}:#{image_upstream_tag}")
-                        rescue Docker::Error::NotFoundError
-                          nil
-end
-
-upstream = SIB::Image.new(image: upstream_docker_image) unless upstream_docker_image.nil?
+upstream = SIB::Image.import(repo: image_repo, tag: image_upstream_tag)
 
-canary_build_args = {
-  'dockerfile' => docker_file,
-  'labels' => {
+build_args = {
+  repo: image_repo,
+  build_dir: build_dir,
+  dockerfile: dockerfile,
+  labels: {
     'maintainer' => 'Slush Systems <ci@slush.systems>',
     'systems.slush.commit-id' => current_commit_id,
     'systems.slush.timestamp' => Time.now.utc.iso8601
-  }.to_json,
-  'squash' => squash
+  },
+  squash: squash
 }
-canary = SIB::Image.new(
-  image: Docker::Image.build_from_dir(build_dir, canary_build_args)
-)
 
-if upstream.nil? || (canary <=> upstream).positive?
-  canary.image.tag(repo: image_repo, tag: image_upstream_tag)
-  canary.image.push(nil, tag: image_upstream_tag)
+canary = SIB::Image.build(build_args)
 
-  canary.image.tag(repo: image_repo, tag: canary.factor_hash)
-  canary.image.push(nil, tag: canary.factor_hash)
+if upstream.nil? || (canary <=> upstream).positive?
+  canary.push_tag(tag: image_upstream_tag)
+  canary.push_tag(tag: canary.factor_hash)
 end

data/lib/service_image_builder.rb

@@ -5,8 +5,13 @@ require 'active_support/core_ext/time' # cherry pick Time extensions
 require 'active_support/core_ext/numeric/time' # cherry pick Time extensions
 require 'active_support/core_ext/integer/time' # cherry pick Time extensions
 require 'active_support/core_ext/object/blank' # cherry pick Object#blank?
+require 'awesome_print'
 require 'digest'
 require 'docker'
-require 'json'
+require 'logger'
+require 'oj'
+require 'pathname'
 
+require_relative 'service_image_builder/errors'
+require_relative 'service_image_builder/logger'
 require_relative 'service_image_builder/image'

data/lib/service_image_builder/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SIB
+  # Error is SIB's top level error
+  class Error < StandardError
+    def initialize(msg)
+      SIB.log.error(msg)
+    end
+  end
+end

data/lib/service_image_builder/image.rb

@@ -1,11 +1,42 @@
 # frozen_string_literal: true
 
 module SIB
-  # SIB::Image represents a docker image that has been built by sib.
+  # SIB::ImageError is raised when an unrecoverable error occurs in Image
+  # operations
+  class ImageError < SIB::Error; end
+  # SIB::Image represents a docker image
   class Image
-    attr_accessor :image
-    def initialize(image:)
+    attr_accessor :image, :repo
+
+    def self.build(repo:, build_dir:, dockerfile: 'Dockerfile', labels: {}, squash: false)
+      build_dir ||= Dir.pwd
+      build_args = {
+        'dockerfile' => dockerfile,
+        'labels' => labels_to_json(labels),
+        'squash' => squash
+      }
+      SIB.log.info("Building #{repo} from #{Pathname.new(build_dir).join(dockerfile)}")
+
+      # TODO: maybe have parse_api_response do the logging & just raise an error
+      # when one gets detected
+      image = Docker::Image.build_from_dir(build_dir, build_args) do |resp|
+        parse_api_response(resp).each do |r|
+          SIB.log.info(r['stream'].rstrip) if r.key?('stream')
+        end
+      end
+
+      new(repo: repo, image: image)
+    end
+
+    def self.import(repo:, tag:)
+      new(repo: repo, image: Docker::Image.create('fromImage' => "#{repo}:#{tag}"))
+    rescue Docker::Error::NotFoundError
+      nil
+    end
+
+    def initialize(repo:, image:)
       @image = image
+      @repo = repo
     end
 
     # Image#<=> is a comparison operator implementation for SIB::Image. If the
@@ -52,8 +83,33 @@ module SIB
       end
     end
 
+    def push_tag(tag:)
+      image.tag(repo: repo, tag: tag)
+      image.push(nil, tag: tag) do |msg|
+        SIB::Image.parse_api_response(msg).each do |r|
+          raise SIB::ImageError, r if r.key?('error')
+
+          SIB.log.info(r)
+        end
+      end
+    end
+
     def timestamp
       @timestamp ||= Time.parse(labels.fetch('systems.slush.timestamp', nil))
     end
+
+    class << self
+      def labels_to_json(labels)
+        Oj.dump(labels || {})
+      rescue Oj::Error => e
+        raise ImageError, "Couldn't convert labels to json: #{e.message}"
+      end
+
+      def parse_api_response(response)
+        response.split("\r\n").map { |r| Oj.load(r) }
+      rescue Oj::Error => e
+        raise ImageError, "Couldn't parse api repsonse: #{e.message}"
+      end
+    end
   end
 end

data/lib/service_image_builder/logger.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# SIB is a module for building Slush Systems docker images
+module SIB
+  # SIB::log serves as a module-level logging method
+  def self.log
+    @log ||= Logger.new(STDOUT).tap do |lager|
+      lager.formatter = proc do |severity, datetime, progname, msg|
+        out = msg.is_a?(String) ? msg : msg.ai(multiline: false)
+        "#{datetime} #{severity} #{progname}: #{out}\n"
+      end
+    end
+  end
+end

data/lib/service_image_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SIB
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/service_image_builder.gemspec

@@ -31,7 +31,10 @@ registry.'
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'awesome_print', '~> 1.8'
   spec.add_dependency 'docker-api', '~> 1.34'
+  spec.add_dependency 'logger', '~> 1.4', '>= 1.4.2'
+  spec.add_dependency 'oj', '~> 3.10'
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'pry-byebug', '~> 3.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_image_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Eric Jacobs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-21 00:00:00.000000000 Z
+date: 2019-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: docker-api
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.34'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -135,7 +183,9 @@ files:
 - bin/setup
 - bin/sib
 - lib/service_image_builder.rb
+- lib/service_image_builder/errors.rb
 - lib/service_image_builder/image.rb
+- lib/service_image_builder/logger.rb
 - lib/service_image_builder/version.rb
 - service_image_builder.gemspec
 homepage: https://slush.systems/