fpm-cookery 0.34.0 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3086c69abf17303cb1bd39d5745435e2166e28a7
-  data.tar.gz: 4200c639a242f38313db74b31eb8231e749ea864
+  metadata.gz: 3a561efdfc9652a27acb7f35a433d93cd063bfb0
+  data.tar.gz: 5a20b744b3b77ea485c29553316938b3ada4982d
 SHA512:
-  metadata.gz: 0d85461efb89f476da92433f2394a6db4ecbfc09258018cdc7a4b4151118d663a2c52c19540ae006ad1b548bb6f2ca946fa90bc44f1e6d3e80fa50a31532e805
-  data.tar.gz: f8550d9d07dfddaa4dd74d46f62294a66d35186c49fea36c95da77f7431870d25b8c3f8f93bee0da1cd87512b12ec7906b4abad7493bed1edd3297c9660f5cad
+  metadata.gz: 14313ecb17e285a764f981fbd67fb60b136183999df07cb1eaf2b6c76cefc310f80d4952a9e191c854bbd9ddfca5a51d634c983285f80ef4688db342a987396a
+  data.tar.gz: fa98c581f573b84022e03be9bffff9b92e92e964eb7b2508e9c49eb0e0ef238006775ee5a7778e86a26f037170df8745eb156b2ce10b5d296ddc71851fe98fcf

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.35.0 (2019-12-18)
+* Add support for building packages inside Docker containers.
+
 # v0.34.0 (2019-06-01)
 * Use factor defaults for `platform` and `target` values. (FooBarQuaxx / #189)
 * Add `:username` and `:password` parameters to the SVN source handler. (tomeon / #191)

data/docker/Dockerfile.ubuntu-1604

@@ -0,0 +1,27 @@
+FROM ubuntu:16.04
+
+RUN apt-get update
+RUN \
+    apt-get install --no-install-recommends -y \
+      curl \
+      wget \
+      git \
+      ruby2.3-dev \
+      build-essential \
+      man-db \
+    && gem install --no-ri --no-rdoc fpm-cookery \
+    && apt-get clean \
+    && rm -rf \
+      /tmp/* \
+      /root/.gem \
+      /var/cache/debconf/* \
+      /var/lib/gems/*/cache/* \
+      /var/lib/apt/lists/* \
+      /var/log/* \
+      /usr/share/X11 \
+      /usr/share/doc/*
+
+COPY docker-entrypoint.sh /
+
+ENTRYPOINT ["/docker-entrypoint.sh"]
+CMD ["fpm-cook"]

data/docker/docker-entrypoint.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+set -eo pipefail
+
+if [ "$1" != "fpm-cook" ]; then
+	exec "$@"
+fi
+
+# Signal fpm-cook that we are already running inside a container to avoid
+# trying to start another one.
+export FPMC_INSIDE_DOCKER=true
+
+if [ -x "/usr/bin/apt-get" ]; then
+	# Ubuntu/Debian containers use a custom apt config to remove archives
+	# after installing a package. We don't want that because it removes
+	# the possibility to cache the apt archive directory.
+	rm -f /etc/apt/apt.conf.d/docker-clean
+
+	# Make sure we have updated apt repositories. Container images usually
+	# have either no updated lists or they are outdated.
+	if [ -n "$FPMC_DEBUG" ]; then
+		apt-get update
+	else
+		apt-get update >/dev/null
+	fi
+fi
+
+# Remove existing temporary directories to ensure a full build
+rm -rf tmp-build tmp-dest
+
+shift
+fpm-cook "$@"
+
+if [ -n "$FPMC_UID" -a -n "$FPMC_GID" ]; then
+	# Change ownership to make sure the user that executed fpm-cook can
+	# modify created files.
+	chown -R ${FPMC_UID}:${FPMC_GID} cache pkg tmp-build tmp-dest
+fi

data/lib/fpm/cookery/cli.rb

@@ -2,6 +2,7 @@ require 'fpm/cookery/book_hook'
 require 'fpm/cookery/recipe'
 require 'fpm/cookery/facts'
 require 'fpm/cookery/packager'
+require 'fpm/cookery/docker_packager'
 require 'fpm/cookery/chain_packager'
 require 'fpm/cookery/omnibus_packager'
 require 'fpm/cookery/log'
@@ -36,6 +37,20 @@ module FPM
       option '--vendor-delimiter', 'DELIMITER', 'vendor delimiter for version string',
         :attribute_name => 'vendor_delimiter'
 
+      # Docker related flags
+      option '--docker', :flag, 'Execute fpm-cookery inside a Docker container',
+        :attribute_name => 'docker'
+      option '--docker-bin', 'BINARY', 'Docker binary to use',
+        :attribute_name => 'docker_bin'
+      option '--docker-image', 'IMAGE-NAME', 'Docker image to use',
+        :attribute_name => 'docker_image'
+      option '--docker-keep-container', :flag, 'Keep Docker container after build (e.g. to debug issues)',
+        :attribute_name => 'docker_keep_container'
+      option '--docker-cache', 'PATHS', 'Container paths to cache (can be a comma separated list)',
+        :attribute_name => 'docker_cache'
+      option '--dockerfile', 'PATHS', 'The Dockerfile to use for a custom container',
+        :attribute_name => 'dockerfile'
+
       class Command < self
         def self.add_recipe_parameter!
           parameter '[RECIPE]', 'the recipe file', :default => 'recipe.rb'
@@ -116,7 +131,10 @@ module FPM
         add_recipe_parameter!
 
         def exec(config, recipe, packager)
-          if recipe.omnibus_package == true
+          # Don't try to launch a new container if we are already running inside one
+          if (config.docker == true or recipe.docker == true) and ENV['FPMC_INSIDE_DOCKER'].nil?
+            FPM::Cookery::DockerPackager.new(recipe, config).run
+          elsif recipe.omnibus_package == true
             FPM::Cookery::OmnibusPackager.new(packager, config).run
           elsif recipe.chain_package == true
             FPM::Cookery::ChainPackager.new(packager, config).run
@@ -146,7 +164,9 @@ module FPM
         add_recipe_parameter!
 
         def exec(config, recipe, packager)
-          if recipe.omnibus_package == true
+          if config.docker == true
+            # Nothing to do!
+          elsif recipe.omnibus_package == true
             FPM::Cookery::OmnibusPackager.new(packager, config).install_build_deps
           elsif recipe.chain_package == true
             FPM::Cookery::ChainPackager.new(packager, config).install_build_deps

data/lib/fpm/cookery/config.rb

@@ -8,7 +8,8 @@ module FPM
         :color, :debug, :target, :platform, :maintainer, :vendor,
         :skip_package, :keep_destdir, :dependency_check, :quiet,
         :tmp_root, :pkg_dir, :cache_dir, :data_dir, :hiera_config,
-        :vendor_delimiter
+        :vendor_delimiter, :docker, :docker_image, :docker_keep_container,
+        :docker_cache, :docker_bin, :dockerfile
       ].freeze
 
       DEFAULTS = {
@@ -17,7 +18,13 @@ module FPM
         :dependency_check => true,
         :skip_package => false,
         :keep_destdir => false,
-        :quiet => false
+        :quiet => false,
+        :docker => false,
+        :docker_image => nil,
+        :docker_keep_container => false,
+        :docker_cache => nil,
+        :docker_bin => 'docker',
+        :dockerfile => 'Dockerfile'
       }.freeze
 
       def self.load_file(paths)

data/lib/fpm/cookery/docker_packager.rb

@@ -0,0 +1,109 @@
+require 'digest/sha1'
+require 'fileutils'
+require 'pathname'
+
+require 'fpm/cookery/version'
+require 'fpm/cookery/facts'
+require 'fpm/cookery/packager'
+require 'fpm/cookery/exceptions'
+
+# Runs the package creation inside a Docker container.
+module FPM
+  module Cookery
+    class DockerPackager
+      include FPM::Cookery::Utils
+
+      attr_reader :packager, :recipe, :config
+
+      def initialize(recipe, config)
+        @recipe = recipe
+        @config = config
+      end
+
+      def run
+        recipe_dir = File.dirname(recipe.filename)
+
+        # The cli settings should have precendence
+        image_name = config.docker_image || recipe.docker_image
+        cache_paths = get_cache_paths
+        docker_bin = config.docker_bin.nil? || config.docker_bin.empty? ? 'docker' : config.docker_bin
+        dockerfile = get_dockerfile(recipe_dir)
+
+        if File.exist?(dockerfile)
+          image_name = "local/fpm-cookery/#{File.basename(recipe_dir)}:latest"
+          Log.info "Building custom Docker image #{image_name} from #{dockerfile}"
+          build_cmd = [
+            config.docker_bin, 'build',
+            '-f', dockerfile,
+            '-t', image_name,
+            '--force-rm',
+            '.'
+          ].compact.flatten.join(' ')
+          sh build_cmd
+        else
+          Log.warn "File #{dockerfile} does not exist - not building a custom Docker image"
+        end
+
+        if image_name.nil? || image_name.empty?
+          image_name = "fpm-cookery:#{FPM::Cookery::VERSION}-#{FPM::Cookery::Facts.platform}-#{FPM::Cookery::Facts.osrelease}"
+        end
+
+        Log.info "Building #{recipe.name}-#{recipe.version} inside a Docker container using image #{image_name}"
+        Log.info "Mounting #{recipe_dir} as /recipe"
+
+        cmd = [
+          config.docker_bin, "run", "-ti",
+          "--name", "fpm-cookery-build-#{File.basename(recipe_dir)}",
+          config.docker_keep_container ? nil : "--rm",
+          "-e", "FPMC_UID=#{Process.uid}",
+          "-e", "FPMC_GID=#{Process.gid}",
+          config.debug ? ["-e", "FPMC_DEBUG=true"] : nil,
+          build_cache_mounts(cache_paths),
+          "-v", "#{recipe_dir}:/recipe",
+          "-w", "/recipe",
+          image_name,
+          "fpm-cook", "package",
+          config.debug ? '-D' : nil,
+          File.basename(recipe.filename)
+        ].compact.flatten.join(' ')
+
+
+        Log.info "Running: #{cmd}"
+        begin
+          sh cmd
+        rescue => e
+          Log.debug e
+        end
+      end
+
+      private
+
+      def get_dockerfile(recipe_dir)
+        path = if config.dockerfile.nil? || config.dockerfile.empty?
+                 Pathname.new(recipe.dockerfile)
+               else
+                 Pathname.new(config.dockerfile)
+               end
+
+        path.absolute? ? path.to_s : File.join(recipe_dir, path.to_s)
+      end
+
+      def get_cache_paths
+        if config.docker_cache.nil? || config.docker_cache.empty?
+          recipe.docker_cache
+        else
+          config.docker_cache.split(',').select do |path|
+            !path.empty?
+          end
+        end
+      end
+
+      def build_cache_mounts(cache_paths)
+        cache_paths.map do |path|
+          next if path.nil? || path.empty?
+          "-v #{recipe.cachedir}/docker/#{Digest::SHA256.hexdigest(path)}:#{path}"
+        end
+      end
+    end
+  end
+end

data/lib/fpm/cookery/facts.rb

@@ -21,7 +21,7 @@ module FPM
         end
 
         def lsbcodename
-          @lsbcodename ||= value(:lsbcodename)
+          @lsbcodename ||= value(:lsbcodename) || value(:lsbdistcodename)
         end
 
         def osmajorrelease

data/lib/fpm/cookery/recipe.rb

@@ -34,12 +34,12 @@ module FPM
               :revision, :section, :sha1, :sha256, :sha512, :spec, :vendor, :version,
               :pre_install, :post_install, :pre_uninstall, :post_uninstall,
               :license, :omnibus_package, :omnibus_dir, :chain_package,
-              :default_prefix
+              :default_prefix, :docker, :docker_image, :dockerfile
 
       attr_rw_list  :build_depends, :config_files, :conflicts, :depends,
                     :exclude, :patches, :provides, :replaces, :omnibus_recipes,
                     :omnibus_additional_paths, :chain_recipes,
-                    :directories
+                    :directories, :docker_cache
 
       attr_rw_hash  :fpm_attributes, :environment
 

data/lib/fpm/cookery/version.rb

@@ -1,5 +1,5 @@
 module FPM
   module Cookery
-    VERSION = '0.34.0'
+    VERSION = '0.35.0'
   end
 end

data/spec/config_spec.rb

@@ -165,7 +165,13 @@ describe 'Config' do
         :skip_package => false,
         :keep_destdir => false,
         :dependency_check => true,
-        :quiet => false
+        :quiet => false,
+        :docker => false,
+        :docker_image => nil,
+        :docker_keep_container => false,
+        :docker_cache => nil,
+        :docker_bin => 'docker',
+        :dockerfile => 'Dockerfile'
       })
     end
   end

data/spec/facts_spec.rb

@@ -31,11 +31,11 @@ describe "Facts" do
       end
     end
 
-    context "where lsbcodename is not present" do
-      include_context "mock facts", { :lsbcodename => nil }
+    context "where lsbcodename is not present but lsbdistcodename is" do
+      include_context "mock facts", { :lsbcodename => nil, :lsbdistcodename => 'trusty' }
 
       it "returns nil" do
-        expect(FPM::Cookery::Facts.lsbcodename).to be_nil
+        expect(FPM::Cookery::Facts.lsbcodename).to eq :trusty
       end
     end
   end

data/spec/recipe_spec.rb

@@ -99,6 +99,24 @@ describe "Recipe" do
     end
   end
 
+  describe "#docker" do
+    it "can be set" do
+      check_attribute(:docker, true)
+    end
+  end
+
+  describe "#docker_image" do
+    it "can be set" do
+      check_attribute(:docker_image, "hello:world")
+    end
+  end
+
+  describe "#dockerfile" do
+    it "can be set" do
+      check_attribute(:dockerfile, "Dockefile")
+    end
+  end
+
   describe "#license" do
     it "can be set" do
       check_attribute(:license, 'MIT')
@@ -305,6 +323,7 @@ describe "Recipe" do
   spec_recipe_attribute_list(:omnibus_recipes, %w{one two})
   spec_recipe_attribute_list(:chain_recipes, %w{one two})
   spec_recipe_attribute_list(:directories, %w{one two})
+  spec_recipe_attribute_list(:docker_cache, %w{one two})
 
   describe ".source" do
     it "sets a source url" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fpm-cookery
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.35.0
 platform: ruby
 authors:
 - Bernd Ahlers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-01 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -204,6 +204,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -212,6 +213,8 @@ files:
 - README.md
 - Rakefile
 - bin/fpm-cook
+- docker/Dockerfile.ubuntu-1604
+- docker/docker-entrypoint.sh
 - docs/.gitignore
 - docs/Makefile
 - docs/conf.py
@@ -225,6 +228,7 @@ files:
 - lib/fpm/cookery/cli.rb
 - lib/fpm/cookery/config.rb
 - lib/fpm/cookery/dependency_inspector.rb
+- lib/fpm/cookery/docker_packager.rb
 - lib/fpm/cookery/environment.rb
 - lib/fpm/cookery/exceptions.rb
 - lib/fpm/cookery/facts.rb