tagfish 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5ff081cce0c22b7b5f8a8139045485d3fa2184d
-  data.tar.gz: 9d316b76e1972b0544bcce06eda7cbe4112f3020
+  metadata.gz: 05b88f51ae087cebd100f07fb24e5b2a6a11556f
+  data.tar.gz: e224ae8aab3b783527d409351f6d20d41b62c9f2
 SHA512:
-  metadata.gz: b7770cdc629f1c9adcd61b2f7b5ce20a3669396b8972841af905ee9ae28dbcd430bc1931b3642fe5cd70b306ea37720032ed3e5a08bbd2b5b49f3058003ab9e5
-  data.tar.gz: 2348139104553d2376420aeebd7b8a9d5eab001a0e3d623ea89cfa1862791d3e80b50304ea45cc31c9f77cabc8f4b25b7322e917320870e97a27711c23885c48
+  metadata.gz: 2ec7003db64bba1a474aa200c7b1a40f888e134eaf14c7fd10e8dbb25ee30d786f7793ffb11616faf0c58dd44f43901ed23a8d9a2c372a0ce58b9bf4d1acb9dc
+  data.tar.gz: fd83a60351e1f12224990304dbe8995d538a4018dfc51d231be449fad58b8e19efe7c8963c37c108aca3d79dff9d7944aa6169d2767189fb6eb954647549bfe0

data/.gitignore

@@ -0,0 +1,14 @@
+*.swp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+/*.gem
+/compiled-gem
+/tests

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+sudo: required
+
+script:
+  - bundle exec rake spec

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM alpine:3.4
+MAINTAINER Clement Labbe <clement.labbe@rea-group.com>
+
+RUN apk add --update \
+    ruby=2.3.1-r0 \
+    ruby-dev=2.3.1-r0 \
+    ruby-io-console=2.3.1-r0 \
+    diffutils \
+    linux-headers \
+    build-base \
+    ca-certificates && \
+    rm /var/cache/apk/* && \
+    rm -rf /usr/share/ri
+
+RUN echo -e 'gem: --no-rdoc --no-ri' > /etc/gemrc
+
+COPY pkg/tagfish-latest.gem /cwd/
+WORKDIR /cwd
+RUN gem install tagfish-latest.gem
+RUN mkdir -p /root/.docker
+
+ENTRYPOINT ["tagfish"]

data/Dockerfile.dev

@@ -0,0 +1,20 @@
+FROM alpine:3.4
+MAINTAINER Clement Labbe <clement.labbe@rea-group.com>
+
+RUN apk add --update \
+    ruby=2.3.1-r0 \
+    ruby-dev=2.3.1-r0 \
+    ruby-io-console=2.3.1-r0 \
+    git \
+    diffutils \
+    linux-headers \
+    build-base \
+    ca-certificates && \
+    rm /var/cache/apk/* && \
+    rm -rf /usr/share/ri
+
+RUN echo -e 'gem: --no-rdoc --no-ri' > /etc/gemrc && \
+    gem update --system && \
+    gem install bundler && \
+    rm -rf /usr/share/ri
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tagfish.gemspec
+gemspec

data/README.md

@@ -0,0 +1,172 @@
+# Tagfish [![Build Status](https://travis-ci.org/realestate-com-au/tagfish.svg?branch=master)](https://travis-ci.org/realestate-com-au/tagfish)
+
+
+![Tagfish logo](logo.png)
+
+Tagfish is a CLI tool to interact with Docker registries. 
+
+Features include:
+
+- List all the tags of a given Docker repository
+- Return the most recent explicit tag of a repository
+- Update a file with the newest tags
+- Authenticate by reading native Docker config file 
+- Works against hub.docker.com and private registries
+- Supports Docker Registry/Distribution API v1 and v2 
+
+To use Tagfish against a registry requiring authentication, you first need to authenticate to the given registry using `docker login <REGISTRY>`.
+
+## Table of contents
+
+<!-- MarkdownTOC autolink=true bracket=round depth=4 -->
+
+- [Usage](#usage)
+  - [`tagfish tags`](#tagfish-tags)
+    - [Example](#example)
+  - [`tagfish update`](#tagfish-update)
+    - [Example](#example-2)
+    - [Official repositories](#official-repositories)
+- [Installation](#installation)
+  - [Gem](#gem)
+    - [Limitations](#limitations)
+  - [Docker image](#docker-image)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Licence](#licence)
+
+
+<!-- /MarkdownTOC -->
+
+## Usage
+The Tagfish CLI tool has different subcommands for interacting with Docker registries.
+
+### `tagfish tags`
+The `tags` subcommands is used to retrieve tags from a given repository:
+
+    Usage:
+        tagfish tags [OPTIONS] REPOSITORY
+
+    Parameters:
+        REPOSITORY                    docker repository
+
+    Options:
+        -l, --latest                  only return latest explicitly tagged image
+        -s, --short                   only return tag, not full image path
+        -h, --help                    print help
+
+Where `repository` is a docker repository path, including the docker registry. The tags are returned in alphabetical order.
+
+The `--latest` option gets the image ID of the docker image tagged `latest` in the repository, finds a matching image with a tag set manually (e.g: date, version number), and returns that tag. This option will not work if there is no image tagged `latest` in your repository.
+
+#### Example
+```
+$ tagfish tags alpine
+alpine:2.6
+alpine:2.7
+alpine:3.1
+alpine:3.2
+alpine:edge
+alpine:latest
+```
+
+### `tagfish update`
+The `update` subcommand is used to update a file with the latest tags available:
+
+    Usage:
+        tagfish update [OPTIONS] FILE
+    
+    Parameters:
+        FILE                          file to update
+    
+    Options:
+        -d, --dry-run                 enable dry run
+        --only PATTERN                Only update repositories matching pattern. Wildcards `*` may be used.
+        -h, --help                    print help
+
+#### Example
+```
+$ tagfish update --dry-run Dockerfile
+-FROM docker-registry.delivery.realestate.com.au/gpde/ubuntu-ruby2.2:201508191500
++FROM docker-registry.delivery.realestate.com.au/gpde/ubuntu-ruby2.2:201511261833
+```
+
+#### Official repositories
+`tagfish update` will update repositories such as:
+```
+private.registry/namespace/repository:tag
+namespace/repository:tag
+```
+However, it will not update the tag of official repositories, such as:
+```
+ubuntu:tag
+```
+This is because updating to a new OS automatically might be something you want to avoid, and because it is hard to match a repository without a namespace.
+
+## Installation
+### Gem
+Tagfish is packaged as a Ruby gem. Install it from the command line:
+
+```
+$ gem install tagfish
+```
+
+#### Limitations
+Tagfish requires Ruby 2.2 or newer if the registry you are accessing restricts TLS to v1.2.
+
+### Docker image
+Tagfish is released as a Docker image as well, and can be run with:
+
+```
+docker run --rm \
+  -v ~/.docker:/root/.docker:ro \
+  -v ${PWD}:/cwd \
+  cowbell/tagfish \
+  <COMMAND>
+```
+## Development
+- Use dev tagfish
+```bash
+$ auto/tagfish
+```
+
+- Run the tests
+```bash
+$ auto/test
+```
+
+- Package gem and Docker image
+```bash
+$ auto/package
+```
+
+- Release gem and Docker image
+```bash
+$ auto/release
+```
+This requires write access to the Git repo, the Gem repo, and the Docker repo.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/realestate-com-au/tagfish .
+
+## Licence
+
+Copyright (c) 2015 REA Group Ltd.
+
+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/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "fileutils"
+
+spec = Gem::Specification::load(Dir.glob("*.gemspec").first)
+gem_file = "pkg/#{spec.name}-#{spec.version}.gem"
+
+task build_latest: [:build] do
+  FileUtils.copy(gem_file, "pkg/tagfish-latest.gem")
+end
+
+require "rspec/core/rake_task"
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/auto/dev-environment

@@ -0,0 +1,11 @@
+#! /bin/bash -e
+#
+# Run rake
+
+cd $(dirname $0)/..
+
+trap "docker-compose down --volumes" 0
+
+docker volume create --name ruby2.3-bundle-cache > /dev/null
+docker-compose run --rm dev sh -c 'bundle check > /dev/null || bundle install'
+docker-compose run --rm dev bundle exec "${@-sh}"

data/auto/package

@@ -0,0 +1,9 @@
+#! /bin/bash -e
+
+cd $(dirname $0)/..
+
+# Build the gem
+auto/dev-environment rake build_latest
+
+# Build the Docker image
+docker build -t cowbell/tagfish:latest .

data/auto/release

@@ -0,0 +1,12 @@
+#! /bin/bash -e
+
+cd $(dirname $0)/..
+
+REPOSITORY=cowbell/tagfish
+VERSION=$(cat lib/tagfish/version.rb | grep VERSION | cut -d'"' -f2)
+
+# Ensure we have no local changes
+git diff HEAD --exit-code
+
+auto/release-gem
+auto/release-docker-image

data/auto/release-docker-image

@@ -0,0 +1,14 @@
+#! /bin/bash -e
+
+cd $(dirname $0)/..
+
+REPOSITORY=cowbell/tagfish
+VERSION=$(cat lib/tagfish/version.rb | grep VERSION | cut -d'"' -f2)
+
+# Build the image
+docker build -t ${REPOSITORY}:latest .
+
+# Release the image
+docker push ${REPOSITORY}:latest
+docker tag ${REPOSITORY}:latest ${REPOSITORY}:${VERSION}
+docker push ${REPOSITORY}:latest

data/auto/release-gem

@@ -0,0 +1,7 @@
+#! /bin/bash -e
+
+cd $(dirname $0)/..
+
+# Release the gem
+auto/dev-environment rake build_latest
+auto/dev-environment rake release

data/auto/tagfish

@@ -0,0 +1,3 @@
+#! /bin/bash -e
+
+$(dirname $0)/dev-environment bin/tagfish "$@"

data/auto/test

@@ -0,0 +1,3 @@
+#! /bin/bash -e
+
+$(dirname $0)/dev-environment rake spec

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: "2"
+
+services:
+  dev:
+    build:
+      context: .
+      dockerfile: Dockerfile.dev
+    environment:
+       - GEM_HOME=/usr/local/bundle
+       - GEM_PATH=/usr/lib/ruby/gems/2.3.0:/usr/local/bundle/gems
+    volumes:
+      - .:/work
+      - ruby2.3-bundle-cache:/usr/local/bundle
+    working_dir: /work
+
+volumes:
+  ruby2.3-bundle-cache:
+    external: true

data/lib/tagfish/cli/update_command.rb

@@ -21,7 +21,7 @@ module Tagfish
           URIFilters.must_not_be_tagged_latest,
           URIFilters.must_match_repository(only)
         ]
-        updater = Updater.new(filters)
+        updater = Updater.new(filters, debug?)
         original = File.read(file)
         updated = Tokeniser.dump(updater.update(Tokeniser.tokenise(original)))
 

data/lib/tagfish/credential_store.rb

@@ -0,0 +1,24 @@
+require 'tagfish/registry_credentials'
+
+module Tagfish
+
+  class CredentialStore
+
+    def initialize(docker_config_data)
+      @credentials_by_registry = {}
+      auths = docker_config_data.fetch("auths", {})
+      auths.each do |registry, data|
+        encoded_credentials = data.fetch("auth")
+        username, password = Base64.decode64(encoded_credentials).split(":")
+        creds = RegistryCredentials.new(username, password)
+        @credentials_by_registry[registry] = creds
+      end
+    end
+
+    def credentials_for(registry)
+      @credentials_by_registry[registry]
+    end
+
+  end
+
+end

data/lib/tagfish/registry_credentials.rb

@@ -0,0 +1,5 @@
+module Tagfish
+
+  RegistryCredentials = Struct.new(:username, :password)
+
+end

data/lib/tagfish/update/updater.rb

@@ -5,8 +5,11 @@ require 'tagfish/docker_registry_client'
 module Tagfish
   module Update
     class Updater
-      def initialize(filters)
+      attr_reader :debug
+
+      def initialize(filters, debug = false)
         @filters = filters
+        @debug = debug
       end
 
       def update(tokens)
@@ -38,7 +41,7 @@ module Tagfish
       end
 
       def update_uri(docker_uri)
-        docker_api = DockerRegistryClient.for(docker_uri)
+        docker_api = DockerRegistryClient.for(docker_uri, debug)
         tags = docker_api.tags
         newest_tag_name = tags.latest_tags.first
         if newest_tag_name.nil?

data/lib/tagfish/version.rb

@@ -1,3 +1,3 @@
 module Tagfish
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

data/tagfish.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tagfish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tagfish"
+  spec.version       = Tagfish::VERSION
+  spec.authors       = ["Clement Labbe"]
+  spec.email         = ["clement.labbe@rea-group.com"]
+  spec.summary       = %q{Command line utility for docker registries}
+  spec.description   = "Retrieve repository tags, update dockerfiles, and more!"
+  spec.homepage      = "https://github.com/realestate-com-au/tagfish"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["tagfish"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_dependency "clamp", "~> 1.0.0"
+  spec.add_dependency "diffy", "~> 3.0.0"
+  spec.add_dependency "json", "~> 1.8.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagfish
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Clement Labbe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-18 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,7 +102,24 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Dockerfile
+- Dockerfile.dev
+- Gemfile
+- README.md
+- Rakefile
+- auto/dev-environment
+- auto/package
+- auto/release
+- auto/release-docker-image
+- auto/release-gem
+- auto/tagfish
+- auto/test
 - bin/tagfish
+- docker-compose.yml
 - lib/tagfish.rb
 - lib/tagfish/api_call.rb
 - lib/tagfish/api_error.rb
@@ -111,18 +128,22 @@ files:
 - lib/tagfish/cli/main_command.rb
 - lib/tagfish/cli/tags_command.rb
 - lib/tagfish/cli/update_command.rb
+- lib/tagfish/credential_store.rb
 - lib/tagfish/docker_http_auth.rb
 - lib/tagfish/docker_registry_client.rb
 - lib/tagfish/docker_registry_v1_client.rb
 - lib/tagfish/docker_registry_v2_client.rb
 - lib/tagfish/docker_registry_vboth_client.rb
 - lib/tagfish/docker_uri.rb
+- lib/tagfish/registry_credentials.rb
 - lib/tagfish/tags.rb
 - lib/tagfish/tokeniser.rb
 - lib/tagfish/update/differ.rb
 - lib/tagfish/update/updater.rb
 - lib/tagfish/update/uri_filters.rb
 - lib/tagfish/version.rb
+- logo.png
+- tagfish.gemspec
 homepage: https://github.com/realestate-com-au/tagfish
 licenses:
 - MIT