service_image_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8550ba8f0f9119b6604a18578ae39aa4f7dba3e3a7c6a938ff5f430e57f3c7e8
+  data.tar.gz: ef00b4c1d45ef83b447173e26752c4afc17ee0dd8804ee75caf784ddd05a5e33
+SHA512:
+  metadata.gz: 5422022c9e4b3a9f7c75d82825a7a1456411fbf44552b4ace376b3ba7c7ffaa82682c1a786a63ac0b7aacacf34f471e5bbf0250b321cd0210416ff13b9c7387d
+  data.tar.gz: a080d2408458ff3639b2eae53fa4a040e195b8b3ab819e1f3faa409dc5a99efd57b4f16790fc3c02e7d2a27273ee63dfad1e43f789f90f7b31924743b6b847ec

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+test:
+  image: ruby:2.6
+  stage: test
+  before_script:
+    - apt-get update -qy
+    - bundle install
+  script:
+    - bundle exec rake
+    - rubocop

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - service_image_builder.gemspec
+Metrics/LineLength:
+  Max: 96

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eric@slush.systems. All complaints
+will be reviewed and investigated and will result in a response that is
+deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in service_image_builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    service_image_builder (0.1.0)
+      activesupport (~> 5.2)
+      docker-api (~> 1.34)
+      pry-byebug (~> 3.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docker-api (1.34.2)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.64.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.70)
+  service_image_builder!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Eric Jacobs
+
+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,16 @@
+# Service Image Builder
+
+This is a Slush Systems tool for building service images. Slush Systems
+creates continuously updated and deployed infrastructure and tooling
+container images. This tool creates, tags, and pushes those images the
+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
+- SIB_BUILD_DIR — Docker build context directory; optional & defaults to $PWD
+- 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'

data/Rakefile

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

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'service/image/builder'
+
+# 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.
+
+require 'pry'
+Pry.start

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/bin/sib

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/service_image_builder.rb'
+
+# This is a sha256 sum of the ouput of `dnf list installed` which contains a
+# list of installed packages and their associated versions. A change in this
+# value from one build to the next indicates that one or more packages have
+# changed.
+#
+# A change in package_manifest should trigger a new tag
+#
+# images pulled from upstream will have this in a docker label
+# otherwise, it needs to
+#
+
+build_dir = ENV.fetch('SIB_BUILD_DIR', '.')
+current_commit_id = ENV.fetch('CI_COMMIT_SHA')
+docker_file = ENV.fetch('SIB_DOCKER_FILE', 'Dockerfile')
+image_repo = ENV.fetch('SIB_IMAGE_REPO')
+image_upstream_tag = ENV.fetch('SIB_UPSTREAM_TAG', 'latest')
+registry_user = ENV.fetch('SIB_REGISTRY_USER')
+registry_pass = ENV.fetch('SIB_REGISTRY_PASS')
+
+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?
+
+canary_build_args = {
+  'dockerfile' => docker_file,
+  'labels' => {
+    'maintainer' => 'Slush Systems <ci@slush.systems>',
+    'systems.slush.commit-id' => current_commit_id,
+    'systems.slush.timestamp' => Time.now.utc.iso8601
+  }.to_json,
+  'squash' => true
+}
+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.image.tag(repo: image_repo, tag: canary.factor_hash)
+  canary.image.push(nil, tag: canary.factor_hash)
+end

data/lib/service_image_builder/image.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SIB
+  # SIB::Image represents a docker image that has been built by sib.
+  class Image
+    attr_accessor :image
+    def initialize(image:)
+      @image = image
+    end
+
+    # Image#<=> is a comparison operator implementation for SIB::Image. If the
+    # factor_hash are the same, they're equal. Otherwise, the latest timestamp
+    # wins.
+    #
+    # @param other; the SIB::Image to compare against
+    def <=>(other)
+      return 0 if factor_hash == other.factor_hash
+
+      timestamp.compare_with_coercion(other.timestamp) # <=> with coercion
+    end
+
+    def commit_id
+      @commit_id ||= labels.fetch('systems.slush.commit-id', nil)
+    end
+
+    def factor_hash
+      @factor_hash ||= Digest::SHA2.new(256).tap do |hash|
+        hash << commit_id
+        hash << package_manifest
+      end.hexdigest[0..15]
+    end
+
+    def labels
+      @labels ||= image.json['Config']['Labels']
+    end
+
+    # Image#package_manifest creates a container from @image and generates the
+    # package-manifest from it
+    def package_manifest
+      @package_manifest ||= String.new.tap do |manifest|
+        container = Docker::Container.create(
+          'Cmd' => ['/bin/bash', '-c',
+                    'dnf list installed | sha256sum | colrm 65 > /package-manifest'],
+          'Image' => image.id
+        )
+        container.tap(&:start).tap(&:wait)
+        manifest << container.read_file('/package-manifest').chomp
+        container.remove
+      end
+    end
+
+    def timestamp
+      @timestamp ||= labels.fetch('systems.slush.timestamp', nil)
+    end
+  end
+end

data/lib/service_image_builder/version.rb

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

data/lib/service_image_builder.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support'
+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 'pry-byebug'
+require 'digest'
+require 'docker'
+
+require_relative 'service_image_builder/image'

data/service_image_builder.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_image_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'service_image_builder'
+  spec.version       = SIB::VERSION
+  spec.authors       = ['Eric Jacobs']
+  spec.email         = ['eric@slush.systems']
+
+  spec.summary       = 'A tool for building and deploying Slush Systems Service Images'
+  spec.description   = 'This is a Slush Systems tool for building service images. Slush Systems
+creates continuously updated and deployed infrastructure and tooling
+container images. This tool creates, tags, and pushes those images the
+registry.'
+  spec.homepage      = 'https://slush.systems/'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/slush-systems/service_image_builder'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/slush-systems/service_image_builder/commits/master'
+
+  # 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        = 'bin'
+  spec.executables   = 'sib'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'docker-api', '~> 1.34'
+  spec.add_dependency 'pry-byebug', '~> 3.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.70'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: service_image_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.34'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  This is a Slush Systems tool for building service images. Slush Systems
+  creates continuously updated and deployed infrastructure and tooling
+  container images. This tool creates, tags, and pushes those images the
+  registry.
+email:
+- eric@slush.systems
+executables:
+- sib
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/sib
+- lib/service_image_builder.rb
+- lib/service_image_builder/image.rb
+- lib/service_image_builder/version.rb
+- service_image_builder.gemspec
+homepage: https://slush.systems/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://slush.systems/
+  source_code_uri: https://gitlab.com/slush-systems/service_image_builder
+  changelog_uri: https://gitlab.com/slush-systems/service_image_builder/commits/master
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A tool for building and deploying Slush Systems Service Images
+test_files: []