puppet_docker_tools 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af7f0af2ac0fb8371c5358179ff8b3d26f10157
-  data.tar.gz: 5c82a30a82d4dbaafbf3e8217a9c8f4b96cb4d5d
+  metadata.gz: 279a8c6d6a95b7d1c5f3f0dc4c045f2b67e363fd
+  data.tar.gz: fa7be0251b3e84ae7fe7be4942c795a578f116e9
 SHA512:
-  metadata.gz: e3f350e40c4f26824845e9e06d820b3fb47d69e165602feb6a9049a3cf7a18f78514670a0f9a53dcae5d07bafc22e644173b93f2d5ec3e815c04ba7daff79c76
-  data.tar.gz: f8092567055f4a50bcecd27682209ff6f3374d46a39806bc6a5a86143d3c3155b9ab5c06b9db87269a109f7e7ab25a1988f7e7e5019fa56f6e0c4c269afec1bd
+  metadata.gz: d1156f61257a15d2bb792ab555d146e6041d0782d072a2467a1766174562f9a10af9486d2b9d82f350ae45f18053467937cfa444664c70ebc0cfaec03c3d51b6
+  data.tar.gz: 5f2e135989bc479afca3e1116c45fff26cb6a43e21c2eacc904a1adf454ae627fb6e67e61d83a248d74fbea348c305f8933e090a2115e14edf2bfe21847629af

data/README.md

@@ -12,8 +12,10 @@ You also need to have docker installed and running. See [these docs](https://doc
 
 ```
 $ puppet-docker help
+Utilities for building and releasing Puppet docker images.
+
 Usage:
-  puppet-docker build [DIRECTORY] [--dockerfile=<dockerfile>] [--repository=<repo>] [--namespace=<namespace>] [--no-cache]
+  puppet-docker build [DIRECTORY] [--dockerfile=<dockerfile>] [--repository=<repo>] [--namespace=<namespace>] [--no-cache] [--version=<version] [--build-arg=<buildarg> ...]
   puppet-docker lint [DIRECTORY] [--dockerfile=<dockerfile>]
   puppet-docker local-lint [DIRECTORY] [--dockerfile=<dockerfile>]
   puppet-docker pull [IMAGE] [--repository=<repo>]
@@ -35,6 +37,9 @@ Options:
   --no-cache                 Disable use of layer cache when building this image. Defaults to using the cache.
   --namespace=<namespace>    Namespace for labels on the container [default: org.label-schema]
   --dockerfile=<dockerfile>  File name for your dockerfile [default: Dockerfile]
+  --version=<version>        Version to build. This field will be used to determine the label and will be passed as the version build arg.
+                             **NOTE** `--build-arg version='<version>'` overrides `--version <version>`
+  --build-arg=<buildarg>     Build arg to pass to container build, can be passed multiple times.
 ```
 
 ### `puppet-docker build`

data/bin/puppet-docker

@@ -7,7 +7,7 @@ doc = <<DOC
 Utilities for building and releasing Puppet docker images.
 
 Usage:
-  puppet-docker build [DIRECTORY] [--dockerfile=<dockerfile>] [--repository=<repo>] [--namespace=<namespace>] [--no-cache]
+  puppet-docker build [DIRECTORY] [--dockerfile=<dockerfile>] [--repository=<repo>] [--namespace=<namespace>] [--no-cache] [--version=<version] [--build-arg=<buildarg> ...]
   puppet-docker lint [DIRECTORY] [--dockerfile=<dockerfile>]
   puppet-docker local-lint [DIRECTORY] [--dockerfile=<dockerfile>]
   puppet-docker pull [IMAGE] [--repository=<repo>]
@@ -29,6 +29,9 @@ Options:
   --no-cache                 Disable use of layer cache when building this image. Defaults to using the cache.
   --namespace=<namespace>    Namespace for labels on the container [default: org.label-schema]
   --dockerfile=<dockerfile>  File name for your dockerfile [default: Dockerfile]
+  --version=<version>        Version to build. This field will be used to determine the label and will be passed as the version build arg.
+                             **NOTE** `--build-arg version='<version>'` overrides `--version <version>`
+  --build-arg=<buildarg>     Build arg to pass to container build, can be passed multiple times.
 DOC
 
 begin
@@ -44,6 +47,8 @@ defaults = {
   '--namespace'  => 'org.label-schema',
   '--repository' => 'puppet',
   '--dockerfile' => 'Dockerfile',
+  '--version'    => nil,
+  '--build-arg'  => [],
 }
 
 options.merge!(defaults) do |key, option, default|
@@ -69,7 +74,7 @@ begin
     command_runner = PuppetDockerTools::Runner.new(directory: options['DIRECTORY'], repository: options['--repository'], namespace: options['--namespace'], dockerfile: options['--dockerfile'])
 
     if options['build']
-      command_runner.build(no_cache: options['--no-cache'])
+      command_runner.build(no_cache: options['--no-cache'], version: options['--version'], build_args: options['--build-arg'])
     elsif options['lint']
       command_runner.lint
     elsif options['local-lint']

data/lib/puppet_docker_tools/runner.rb

@@ -24,24 +24,50 @@ class PuppetDockerTools
     #
     # @param no_cache Whether or not to use existing layer caches when building
     #        this image. Defaults to using the cache (no_cache = false).
-    def build(no_cache: false)
+    # @param version Set the version for the container explicitly. Will get
+    #        passed as the 'version' buildarg.
+    # @param build_args Pass arbitrary buildargs to the container build.
+    #        Expected to be an array of strings, each string formatted like
+    #        'arg=value'.
+    def build(no_cache: false, version: nil, build_args: [])
       image_name = File.basename(directory)
-      version = PuppetDockerTools::Utilities.get_value_from_env('version', namespace: namespace, directory: directory, dockerfile: dockerfile)
-      path = "#{repository}/#{image_name}"
-      puts "Building #{path}:latest"
-
-      build_args = {
+      build_args_hash = {
         'vcs_ref' => PuppetDockerTools::Utilities.current_git_sha(directory),
         'build_date' => Time.now.utc.iso8601
       }
 
+      # if version is passed in, add that into the build_args hash
+      # **NOTE** if both `version` and `build_args` includes `version=something`
+      #          the value in `build_args` takes precedence
+      build_args_hash['version'] = version unless version.nil?
+
+      # Convert the build_args array to a hash, and merge it with the values
+      # that have already been set
+      if Array(build_args).any?
+        build_args_hash.merge!(PuppetDockerTools::Utilities.parse_build_args(Array(build_args)))
+      end
+
+      # This variable is meant to be used for building the non-latest tagged build
+      # If the version was set via `version` or `build_args`, use that. If not,
+      # use `get_value_from_env` to parse that value from the dockerfile.
+      #
+      # If version hasn't been passed in via `version` or `build_args` there's
+      # no need to add the version from `get_value_from_env` to the
+      # build_args_hash, dockerfiles should not be using both hardcoded versions
+      # and versions passed in to the dockerfile with an `ARG`
+      version = build_args_hash['version'] || PuppetDockerTools::Utilities.get_value_from_env('version', namespace: namespace, directory: directory, dockerfile: dockerfile)
+
+      path = "#{repository}/#{image_name}"
+      puts "Building #{path}:latest"
+
       # 't' in the build_options sets the tag for the image we're building
-      build_options = { 't' => "#{path}:latest", 'dockerfile' => dockerfile, 'buildargs' => "#{build_args.to_json}"}
+      build_options = { 't' => "#{path}:latest", 'dockerfile' => dockerfile, 'buildargs' => "#{build_args_hash.to_json}"}
 
       if no_cache
         puts "Ignoring cache for #{path}"
         build_options['nocache'] = true
       end
+
       Docker::Image.build_from_dir(directory, build_options)
 
       if version

data/lib/puppet_docker_tools/utilities.rb

@@ -26,6 +26,25 @@ class PuppetDockerTools
       end
     end
 
+    # parse build args into a hash for easier manipulation
+    #
+    # @param build_args array of build_args with each entry in the format 'arg=value'
+    def parse_build_args(build_args)
+      args_hash = {}
+
+      build_args.each do |arg|
+        fields = arg.split('=')
+        key = fields.first
+        # get rid of the key from the fields so we can get the value
+        fields.shift
+        # join the remaining fields with '=' in case the value had '=' in it
+        value = fields.join('=')
+        args_hash[key] = value
+      end
+
+      args_hash
+    end
+
     # Get a value from the labels on a docker image
     #
     # @param image The docker image you want to get a value from, e.g. 'puppet/puppetserver'
@@ -52,7 +71,12 @@ class PuppetDockerTools
 
       value = text.scan(/#{Regexp.escape(namespace)}\.(.+)=(.+) \\?/).to_h[label]
       # expand out environment variables
-      value = get_value_from_variable(value, directory: directory, dockerfile: dockerfile, dockerfile_contents: text) if value.start_with?('$')
+      # This supports either label=$variable or label="$variable"
+      if value.start_with?('$') || value.start_with?('"$')
+        # if variable is quoted, get rid of leading and trailing quotes
+        value.gsub!(/\A"|"\Z/, '')
+        value = get_value_from_variable(value, directory: directory, dockerfile: dockerfile, dockerfile_contents: text)
+      end
       # check in higher-level image if we didn't find it defined in this docker file
       value = get_value_from_base_image(label, namespace: namespace, directory: directory, dockerfile: dockerfile) if value.nil?
       # This gets rid of leading or trailing quotes

data/spec/lib/puppet_docker_tools/runner_spec.rb

@@ -12,6 +12,8 @@ describe PuppetDockerTools::Runner do
 
   let(:runner) { create_runner(directory: '/tmp/test-image', repository: 'test', namespace: 'org.label-schema', dockerfile: 'Dockerfile') }
   let(:buildargs) {{ 'vcs_ref' => 'b0c5ead01b6cabdb3f01871bce699be165c3288f', 'build_date' => '2018-06-08T17:18:13Z' }.to_json}
+  let(:buildargs_with_version) {{ 'vcs_ref' => 'b0c5ead01b6cabdb3f01871bce699be165c3288f', 'build_date' => '2018-06-08T17:18:13Z', 'version' => '1.2.3' }.to_json}
+  let(:extra_buildargs) {{ 'vcs_ref' => 'b0c5ead01b6cabdb3f01871bce699be165c3288f', 'build_date' => '2018-06-08T17:18:13Z', 'foo' => 'bar', 'baz' => 'test=with=equals' }.to_json}
 
   describe '#initialize' do
     it "should fail if the dockerfile doesn't exist" do
@@ -42,6 +44,24 @@ describe PuppetDockerTools::Runner do
       runner.build(no_cache: true)
     end
 
+    it 'passes the version when that parameter is set' do
+      expect(Docker::Image).to receive(:build_from_dir).with(runner.directory, { 't' => 'test/test-image:latest', 'dockerfile' => runner.dockerfile, 'buildargs' => buildargs_with_version }).and_return(image)
+      expect(Docker::Image).to receive(:build_from_dir).with(runner.directory, { 't' => 'test/test-image:1.2.3', 'dockerfile' => runner.dockerfile, 'buildargs' => buildargs_with_version }).and_return(image)
+      runner.build(version: '1.2.3')
+    end
+
+    it 'passes arbitrary build args' do
+      expect(PuppetDockerTools::Utilities).to receive(:get_value_from_env).with('version', namespace: runner.namespace, directory: runner.directory, dockerfile: runner.dockerfile).and_return(nil)
+      expect(Docker::Image).to receive(:build_from_dir).with(runner.directory, { 't' => 'test/test-image:latest', 'dockerfile' => runner.dockerfile, 'buildargs' => extra_buildargs }).and_return(image)
+      runner.build(build_args: ['foo=bar', 'baz=test=with=equals'])
+    end
+
+    it 'prioritizes version as a build arg over regular version' do
+      expect(Docker::Image).to receive(:build_from_dir).with(runner.directory, { 't' => 'test/test-image:latest', 'dockerfile' => runner.dockerfile, 'buildargs' => buildargs_with_version }).and_return(image)
+      expect(Docker::Image).to receive(:build_from_dir).with(runner.directory, { 't' => 'test/test-image:1.2.3', 'dockerfile' => runner.dockerfile, 'buildargs' => buildargs_with_version }).and_return(image)
+      runner.build(version: '1.2.4', build_args: ['version=1.2.3'])
+    end
+
     it 'uses a custom dockerfile if passed' do
       allow(File).to receive(:exist?).with('/tmp/test-image/Dockerfile.test').and_return(true)
       expect(PuppetDockerTools::Utilities).to receive(:get_value_from_env).with('version', namespace: 'org.label-schema', directory: '/tmp/test-image', dockerfile: 'Dockerfile.test').and_return(nil)

data/spec/lib/puppet_docker_tools/utilities_spec.rb

@@ -13,7 +13,7 @@ LABEL maintainer="Puppet Release Team <release@puppet.com>" \\
       org.label-schema.url="https://github.com/puppetlabs/puppet-in-docker" \\
       org.label-schema.name="Puppet Server (No PuppetDB)" \\
       org.label-schema.license="Apache-2.0" \\
-      org.label-schema.version=$PUPPET_SERVER_VERSION \\
+      org.label-schema.version="$PUPPET_SERVER_VERSION" \\
       org.label-schema.vcs-url="https://github.com/puppetlabs/puppet-in-docker" \\
       org.label-schema.vcs-ref="b75674e1fbf52f7821f7900ab22a19f1a10cafdb" \\
       org.label-schema.build-date="2018-05-09T20:11:01Z" \\
@@ -204,4 +204,22 @@ HERE
       expect(PuppetDockerTools::Utilities.get_hadolint_command).to eq('hadolint --ignore DL3008 --ignore DL3018 --ignore DL4000 --ignore DL4001 -')
     end
   end
+
+  describe '#parse_build_args' do
+    let(:build_args) {
+      [
+        'foo=bar',
+        'test=a=string=with==equals'
+      ]
+    }
+    let(:build_args_hash) {
+      {
+        'foo' => 'bar',
+        'test' => 'a=string=with==equals'
+      }
+    }
+    it 'converts the array to a hash' do
+      expect(PuppetDockerTools::Utilities.parse_build_args(build_args)).to eq(build_args_hash)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_docker_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api