fig-lock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3ee68dd9533f30826adbc4476c751c7b2b2e94f
+  data.tar.gz: 5face655d47fc8a3bc173bcb08f73f3c1c6b656f
+SHA512:
+  metadata.gz: cd3ff4c1df4b0535ef36c7fb356d1f7466d0f699fecf93de503abf252a60f3f9b76b7a93ab20147e247b9384e25e25734c753205be43fef92619119b5460bb04
+  data.tar.gz: 8f174825d487d3c781887e329f568f568f3a4f5c8599b702a855720cdf87c1124ac9b69f54972a6ec99f6201b153fcdd2e49c43b65240300ee1f91c941836174

data/.gitignore

@@ -0,0 +1,18 @@
+coverage
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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,47 @@
+# Fig::Lock
+
+Generates fig.lock files based on fig.yml files.
+Gets the latest versions of all images defined in a
+fig.yml file, rewrites them to include the specific tags 
+of those versions, generates a fig.lock file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fig-lock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fig-lock
+
+## Usage
+
+### Install
+The *install* command uses docker to retrieve all images
+defined in fig.lock. If no fig.lock file exists, one will
+be generated by invoking the *update* command.
+```
+  fig-lock install </path/to/fig.yml>
+```
+
+### Update
+The *update* command uses docker to retrieve the latest versions
+of all images defined in the fig.yml file and generates/updates
+a corresponding fig.lock file in the same directory as the fig.yml file,
+which uses specific version tags for these images.
+```
+  fig-lock update </path/to/fig.yml>
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/fig-lock/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default=>:spec

data/bin/fig-lock

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$:.unshift(File.join(__dir__, '..', 'lib'))
+require 'fig/lock/cli'
+

data/fig-lock.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fig/lock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fig-lock"
+  spec.version       = Fig::Lock::VERSION
+  spec.authors       = ["Michael Shea"]
+  spec.email         = ["michael.shea@salesforce.com"]
+  spec.summary       = %q{Generates fig.lock files from fig.yml files}
+  spec.description   = %q{Generates fig.lock files from fig.yml files}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "slop"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+
+end

data/lib/fig/lock.rb

@@ -0,0 +1,116 @@
+require 'yaml'
+require 'fig/lock/log'
+require 'fig/lock/version'
+
+module Fig
+  class Lock
+    class << self
+      def install(opts={})
+        Lock.new(opts).install
+      end
+
+      def update(opts={})
+        Lock.new(opts).update
+      end
+    end
+  end
+end
+
+module Fig
+  class Lock
+    include Fig::Lock::Log
+
+    attr_reader :lock_file, :file
+
+    def initialize(opts)
+      opts = merge_opts(opts)
+      @file = opts[:file]
+      @lock_file = lock_file_name(file)
+
+      fail "File #{file} does not exist" unless File.exists?(file)
+      fail "File #{file} is a directory" if File.directory?(file)
+    end
+
+    # Install images from a lock file on the local system
+    def install
+      if File.exists?(lock_file)
+        log.info "Lock file #{lock_file} found."
+        fetch_images(YAML.load(File.read(lock_file)))
+      else
+        log.info "No lock file found."
+        update
+      end
+    end
+
+    # Update an existing lock file, or create if none exists
+    def update
+      log.info "Generating lock file for #{file} ..."
+      hash = YAML.load(File.read(file))
+
+      fetch_images(hash)
+      select_latest(hash)
+
+      File.write(lock_file, hash.to_yaml)
+    end
+
+    private
+
+    # Construct the name of the lock file from the name of the fig file
+    def lock_file_name(file)
+      index = file.rindex('.')
+      raise "Input file #{file} has no file extension" unless index
+      file[0, index] << '.lock'
+    end
+
+    # Select the latest version for images in the fig hash. Updates the input hash.
+    def select_latest(hash)
+      log.info "Selecting latest tags:"
+      hash.each do |k,v|
+        image = v['image']
+        unless image.nil?
+          output = `sudo docker images #{image}`
+          fail "Unable to list image: #{image}.\n\tExit code:#{$?.exitstatus}\n\tOutput:#{output}" unless $?.exitstatus.zero?
+          tag = output.split("\n")[1].split(' ')[1]
+          tagged_image = "#{image}:#{tag}"
+          log.info "Resolved: #{tagged_image}"
+          v['image'] = tagged_image
+        end
+      end
+    end
+
+    # Fetch all images from the fig hash.
+    def fetch_images(hash)
+      log.info "Fetching images:"
+      hash.each do |k,v|
+        image = v['image']
+        if image
+          log.info "Fetching #{image} ..."
+          system "sudo docker pull #{image}"
+          fail "Unable to fetch image: #{image}.\n\tExit code:#{$?.exitstatus}" unless $?.exitstatus.zero?
+        end
+      end
+      log.info "Done fetching images."
+    end
+
+    def merge_opts(opts)
+      Defaults.opts.merge(opts).tap do |hash|
+        fail("file must be specified") unless hash[:file]
+      end
+    end
+  end
+
+  # Default values for parameters
+  class Defaults
+    class << self
+      def opts
+        {
+          file: file
+        }
+      end
+
+      def file
+        ENV.fetch 'FIG_FILE', File.join(__dir__, 'fig.yml')
+      end
+    end
+  end
+end

data/lib/fig/lock/cli.rb

@@ -0,0 +1,42 @@
+require 'slop'
+require 'fig/lock'
+require 'fig/lock/log'
+
+def cmd_args(command, args)
+  if args.empty?
+    {}
+  elsif args.size == 1
+    {file: args[0]}
+  else
+    fail "Usage: fig-lock #{command} <file>"
+  end
+end
+
+# Execute a block.
+def execute(&block)
+  run do |opts, args|
+    begin
+      yield(opts, args)
+    rescue StandardError => bang
+      if ENV['DEBUG']
+        Fig::Lock::Log.log.fatal bang
+      else
+        Fig::Lock::Log.log.fatal bang.message
+      end
+    end
+  end
+end
+
+opts = Slop.parse do
+  command 'install' do
+    execute do |opts, args|
+      Fig::Lock.install cmd_args('install', args)
+    end
+  end
+
+  command 'update' do
+    execute do |opts, args|
+      Fig::Lock.update cmd_args('update', args)
+    end
+  end
+end

data/lib/fig/lock/log.rb

@@ -0,0 +1,18 @@
+require 'logger'
+require 'fig/lock/version'
+
+module Fig::Lock::Log
+  def log
+    Fig::Lock::Log.log
+  end
+end
+
+module Fig::Lock::Log
+  class << self
+    def log
+      @log ||= Logger.new(STDOUT).tap do |l|
+        l.level = Logger.const_get(ENV.fetch('LOG_LEVEL', 'INFO').upcase)
+      end
+    end
+  end
+end

data/lib/fig/lock/version.rb

@@ -0,0 +1,5 @@
+module Fig
+  class Lock
+    VERSION = "0.0.1"
+  end
+end

data/spec/fig/lock_spec.rb

@@ -0,0 +1,100 @@
+$:.unshift(File.join(__dir__, '..', '..', 'lib'))
+
+RSpec.configure do |config|
+  require 'simplecov'
+  SimpleCov.add_filter 'vendor'
+  SimpleCov.add_filter 'spec'
+  SimpleCov.start
+end
+
+
+require 'fig/lock'
+
+module Fig
+
+  describe Lock do
+
+    before :each do
+      ENV['LOG_LEVEL'] = 'FATAL'
+    end
+
+    context 'class operations' do
+      it 'should install' do
+        expect(Lock).to receive(:new).with({}){
+          double('lock').tap do |lock|
+            expect(lock).to receive(:install)
+          end
+        }
+        Lock.install({})
+      end
+
+      it 'should update' do
+        expect(Lock).to receive(:new).with({}){
+          double('lock').tap do |lock|
+            expect(lock).to receive(:update)
+          end
+        }
+        Lock.update({})
+      end
+    end
+
+    context 'instance operations' do
+
+      before :each do
+        allow(File).to receive(:exists?).with('fig.yml'){true}
+        allow(File).to receive(:directory?).with('fig.yml'){false}
+        allow(File).to receive(:read).with('fig.yml'){yaml}
+        allow(File).to receive(:read).with('fig.lock'){yaml}
+      end
+
+      it 'should install' do
+        lock = Fig::Lock.new(registry: 'some.docker.com', file:'fig.yml')
+        allow(File).to receive(:exists?).with('fig.lock'){true}
+
+        expect(lock).to receive(:system).with('sudo docker pull some.docker.com/atlas/api'){true}
+
+        lock.install
+      end
+
+      it 'should update if no fig.lock exists' do
+        lock = Fig::Lock.new(registry: 'some.docker.com', file:'fig.yml')
+        allow(File).to receive(:exists?).with('fig.lock'){false}
+        expect(lock).to receive(:update)
+        lock.install
+      end
+
+      it 'should update' do
+        lock = Fig::Lock.new(registry: 'some.docker.com', file:'fig.yml')
+
+        expect(lock).to receive(:system).with('sudo docker pull some.docker.com/atlas/api'){true}
+        expect(lock).to receive(:`).with('sudo docker images some.docker.com/atlas/api'){docker_image_output}
+        expect(File).to receive(:write).with('fig.lock', expected_fig_lock)
+
+        lock.update
+      end
+
+      def expected_fig_lock
+        <<-eos
+---
+web:
+  image: some.docker.com/atlas/api:20140611142604
+        eos
+      end
+
+      def docker_image_output
+        <<-eos
+REPOSITORY                        TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
+some.docker.com/atlas/api         20140611142604      784dfb100eb0        4 hours ago         376.4 MB
+        eos
+      end
+
+      def yaml
+        <<-eos
+---
+web:
+  image: some.docker.com/atlas/api
+        eos
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fig-lock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Shea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates fig.lock files from fig.yml files
+email:
+- michael.shea@salesforce.com
+executables:
+- fig-lock
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fig-lock
+- fig-lock.gemspec
+- lib/fig/lock.rb
+- lib/fig/lock/cli.rb
+- lib/fig/lock/log.rb
+- lib/fig/lock/version.rb
+- spec/fig/lock_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generates fig.lock files from fig.yml files
+test_files:
+- spec/fig/lock_spec.rb