dry-dock 0.1.0

data/spec/drydock/object_caches/no_cache_spec.rb

@@ -0,0 +1,62 @@
+
+RSpec.describe Drydock::ObjectCaches::NoCache do
+
+  describe '.new' do
+    it 'takes no arguments' do
+      expect { described_class.new }.not_to raise_error
+    end
+  end
+
+  describe '#fetch' do
+    blk = Proc.new { :value }
+    let(:cache) { described_class.new }
+
+    it 'always executes the block' do
+      expect(blk).to receive(:call) { :value }.exactly(3).times
+      expect { cache.fetch(:foo, &blk) }.not_to raise_error
+      expect(cache.fetch(:foo, &blk)).to eq(:value)
+      expect(cache.fetch(:foo, &blk)).to eq(:value)
+    end
+  end
+
+  describe '#get' do
+    blk = Proc.new { :value }
+    let(:cache) { described_class.new }
+
+    it 'always returns nil' do
+      expect(blk).not_to receive(:call)
+      expect { cache.get(:foo) }.not_to raise_error
+      expect(cache.get(:foo)).to be_nil
+    end
+  end
+
+  describe '#set' do
+    let(:cache) { described_class.new }
+
+    context 'when given a value' do
+      it 'returns nil' do
+        blk = Proc.new { |f| }
+        expect(blk).not_to receive(:call)
+        expect(cache.set(:foo, :some_value)).to be_nil
+      end
+    end
+
+    context 'when given a writer block' do
+      it 'returns nil' do
+        blk = Proc.new { |f| }
+        expect(blk).to receive(:call).once
+        expect(cache.set(:foo, &blk)).to be_nil
+      end
+
+      it 'invokes the block with a file' do
+        file = nil
+        blk = Proc.new { |f| }
+        expect(blk).to receive(:call) { |f| file = f }.once
+
+        cache.set(:foo, &blk)
+        expect(file).to be_an(IO)
+      end
+    end
+  end
+
+end

data/spec/drydock/phase_chain_spec.rb

@@ -0,0 +1,118 @@
+
+RSpec.describe Drydock::PhaseChain do
+
+  EXPECTED_IMAGE_TO_ID_MAPPINGS = {
+    'alpine' => {
+      '3.2'    => 'f4fddc471ec2',
+      'latest' => 'f4fddc471ec2'
+    }
+  }
+
+  describe '.from_repo' do
+
+    it 'takes a repo name forced without a tag' do
+      expect { described_class.from_repo('alpine', nil) }.not_to raise_error
+    end
+
+    it 'takes a repo name without a tag' do
+      expect { described_class.from_repo('alpine') }.not_to raise_error
+    end
+
+    it 'takes a repo name and tag' do
+      expect { described_class.from_repo('alpine', 'latest') }.not_to raise_error
+    end
+
+  end
+
+  describe '#root_image' do
+
+    subject { described_class.from_repo('alpine', '3.2').root_image }
+
+    it 'returns the image object' do
+      expect(subject).to be_a(Docker::Image)
+    end
+
+    it 'matches the image ID' do
+      expect(subject.id).to eq(EXPECTED_IMAGE_TO_ID_MAPPINGS['alpine']['3.2'])
+    end
+
+  end
+
+  describe '#images' do
+
+    let(:chain) { described_class.from_repo('alpine', '3.2') }
+    subject { chain.images }
+
+    it 'returns only the root object' do
+      expect(subject).to eq([chain.root_image])
+    end
+
+  end
+
+  describe '#last_image' do
+
+    let(:chain) { described_class.from_repo('alpine', '3.2') }
+    subject { chain.last_image }
+    it { is_expected.to be_nil }
+
+  end
+
+  describe '#run' do
+
+    let(:chain) { described_class.from_repo('alpine', '3.2') }
+
+    it 'runs a simple command successfully' do
+      expect(chain.images.size).to eq(1)
+      expect { chain.run('/bin/hostname') }.not_to raise_error
+      expect(chain.images.size).to eq(2)
+      expect { chain.destroy! }.not_to raise_error
+    end
+
+    it 'runs a command without committing successfully' do
+      expect(chain.images.size).to eq(1)
+      expect { chain.run('/bin/hostname', no_commit: true) }.not_to raise_error
+      expect(chain.images.size).to eq(1)
+      expect { chain.destroy! }.not_to raise_error
+    end
+
+    it 'sets a comment or author when provided' do
+      expect { chain.run('/bin/hostname', comment: 'Some random comment', author: 'John Doe') }.not_to raise_error
+      chain.last_image.tap do |image|
+        image.refresh!
+        expect(image.info['Comment']).to eq('Some random comment')
+        expect(image.info['Author']).to eq('John Doe')
+      end
+      expect { chain.destroy! }.not_to raise_error
+    end
+
+    it 'sets a command' do
+      expect { chain.run('/bin/hostname', command: ['/bin/ls', '/']) }.not_to raise_error
+      chain.last_image.tap do |image|
+        image.refresh!
+        expect(image.info['Config']['Cmd']).to eq(['/bin/ls', '/'])
+      end
+      expect { chain.destroy! }.not_to raise_error
+    end
+
+    it 'sets an environment' do
+      expect { chain.run('/bin/hostname', env: ["APP_ROOT=/app", "BUILD_ROOT=/build"]) }.not_to raise_error
+      chain.last_image.tap do |image|
+        image.refresh!
+        expect(image.info['Config']['Env']).to include('APP_ROOT=/app')
+        expect(image.info['Config']['Env']).to include('BUILD_ROOT=/build')
+      end
+      expect { chain.destroy! }.not_to raise_error
+    end
+
+    it 'exposes a port' do
+      expect { chain.run('/bin/hostname', expose: ['80/tcp']) }.not_to raise_error
+      chain.last_image.tap do |image|
+        image.refresh!
+        expect(image.info['Config']['ExposedPorts']).to eq("80/tcp" => {})
+      end
+      expect { chain.destroy! }.not_to raise_error
+    end
+
+  end
+
+end

data/spec/drydock/phase_spec.rb

@@ -0,0 +1,67 @@
+
+RSpec.describe Drydock::Phase do
+  
+  describe '.from' do
+
+    it 'takes optional values' do
+      expect { described_class.from({}) }.not_to raise_error
+    end
+
+    [:source_image, :build_container, :result_image].each do |name|
+      it "takes a valid #{name} attribute" do
+        expect { described_class.from(name => 'value_x') }.not_to raise_error
+      end
+    end
+
+    it 'rejects an invalid attribute' do
+      expect { described_class.from(whatever: 'value_x') }.to raise_error(ArgumentError)
+    end
+
+  end
+
+  let(:build_container)     { double('BuildContainer') }
+  let(:no_build_container)  { described_class.from(source_image: '123', result_image: '456') }
+  let(:has_build_container) { described_class.from(source_image: '123', result_image: '456', build_container: build_container) }
+
+  describe '#cached?' do
+
+    context 'when a build container is missing' do
+      subject { no_build_container.cached? }
+      it { is_expected.to be_truthy }
+    end
+
+    context 'when a build container is present' do
+      subject { has_build_container.cached? }
+      it { is_expected.to be_falsey }
+    end
+
+  end
+
+  describe '#built?' do
+
+    context 'when a build container is missing' do
+      subject { no_build_container.built? }
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when a build container is present' do
+      subject { has_build_container.built? }
+      it { is_expected.to be_truthy }
+    end
+
+  end
+
+  describe 'finalize!' do
+
+    it 'when a build container is missing' do
+      expect { no_build_container.finalize! }.not_to raise_error
+    end
+
+    it 'when a build container is present' do
+      expect(build_container).to receive(:remove).with(hash_including(:force))
+      expect { has_build_container.finalize! }.not_to raise_error
+    end
+
+  end
+
+end

data/spec/drydock/plugins/apk_spec.rb

@@ -0,0 +1,49 @@
+
+RSpec.describe Drydock::Plugins::APK do
+
+  let(:project) { double('Project') }
+  let(:plugin)  { described_class.new(project) }
+
+  describe '#add' do
+
+    it 'adds one package' do
+      expect(project).to receive(:run).with('apk add ruby', {})
+      expect { plugin.add('ruby') }.not_to raise_error
+    end
+
+    it 'adds more than one packages' do
+      expect(project).to receive(:run).with('apk add curl ruby nodejs', {})
+      expect { plugin.add('curl', 'ruby', 'nodejs') }.not_to raise_error
+    end
+
+  end
+
+  describe '#remove' do
+
+    it 'deletes one package' do
+      expect(project).to receive(:run).with('apk del ruby')
+      expect { plugin.remove('ruby') }.not_to raise_error
+    end
+
+    it 'deletes more than one packages' do
+      expect(project).to receive(:run).with('apk del curl python nginx')
+      expect { plugin.remove('curl', 'python', 'nginx') }.not_to raise_error
+    end
+
+  end
+
+  describe '#update' do
+    it 'updates the package index' do
+      expect(project).to receive(:run).with('apk update')
+      expect { plugin.update }.not_to raise_error
+    end
+  end
+
+  describe '#upgrade' do
+    it 'upgrades the installed packages' do
+      expect(project).to receive(:run).with('apk upgrade')
+      expect { plugin.upgrade }.not_to raise_error
+    end
+  end
+
+end

data/spec/drydock/plugins/base_spec.rb

@@ -0,0 +1,13 @@
+
+RSpec.describe Drydock::Plugins::Base do
+
+  describe '.new' do
+
+    it 'accepts a project' do
+      project = double('Project')
+      expect { described_class.new(project) }.not_to raise_error
+    end
+
+  end
+
+end

data/spec/drydock/plugins/npm_spec.rb

@@ -0,0 +1,26 @@
+
+RSpec.describe Drydock::Plugins::NPM do
+
+  let(:project) { double('Project') }
+  let(:plugin)  { described_class.new(project) }
+
+  describe '#install' do
+
+    it 'adds one package' do
+      expect(project).to receive(:run).with('npm install sinopia')
+      expect { plugin.install('sinopia') }.not_to raise_error
+    end
+
+    it 'adds one package globally' do
+      expect(project).to receive(:run).with('npm install -g bower')
+      expect { plugin.install('bower', g: true) }.not_to raise_error
+    end
+
+    it 'adds more than one packages' do
+      expect(project).to receive(:run).with('npm install sinopia bower')
+      expect { plugin.install('sinopia', 'bower') }.not_to raise_error
+    end
+
+  end
+
+end

data/spec/drydock/plugins/package_manager_spec.rb

@@ -0,0 +1,12 @@
+
+RSpec.describe Drydock::Plugins::PackageManager do
+
+  [:add, :clean, :remove, :update, :upgrade].each do |action|
+    describe "##{action}" do
+      it 'is not implemented' do
+        expect { described_class.new(nil).public_send(action) }.to raise_error(NotImplementedError)
+      end
+    end
+  end
+
+end

data/spec/drydock/plugins/rubygems_spec.rb

@@ -0,0 +1,53 @@
+
+RSpec.describe Drydock::Plugins::Rubygems do
+
+  let(:project) { double('Project') }
+  let(:plugin)  { described_class.new(project) }
+
+  describe '#add_source' do
+
+    it 'adds one source' do
+      expect(project).to receive(:run).with('gem sources --add http://whatever/')
+      expect { plugin.add_source('http://whatever/') }.not_to raise_error
+    end
+
+  end
+
+  describe '#remove_source' do
+
+    it 'removes one source' do
+      expect(project).to receive(:run).with('gem sources --remove http://whatever/')
+      expect { plugin.remove_source('http://whatever/') }.not_to raise_error
+    end
+
+  end
+
+  describe '#install' do
+
+    it 'installs one package' do
+      expect(project).to receive(:run).with('gem install curb ', timeout: 120)
+      expect { plugin.install('curb') }.not_to raise_error
+    end
+
+    it 'installs one package with timeout' do
+      expect(project).to receive(:run).with('gem install curb ', timeout: 45)
+      expect { plugin.install('curb', timeout: 45) }.not_to raise_error
+    end
+
+    it 'installs one package without docs' do
+      expect(project).to receive(:run).with('gem install curb --no-rdoc --no-ri ', timeout: 120)
+      expect { plugin.install('curb', rdoc: false, ri: false) }.not_to raise_error
+    end
+
+  end
+
+  describe '#update_system' do
+
+    it 'updates rubygems' do
+      expect(project).to receive(:run).with('gem update --system ', timeout: 200)
+      expect { plugin.update_system(timeout: 200) }.not_to raise_error
+    end
+
+  end
+
+end

data/spec/drydock/project_import_spec.rb

@@ -0,0 +1,39 @@
+
+RSpec.describe Drydock::Project do
+
+  let(:project) { described_class.new }
+  after(:each) { project.destroy!(force: true) if project }
+
+  it 'derives a project and imports between derivations' do
+    project.from('alpine')
+    project.mkdir('/app/1')
+
+    build = project.derive
+    build.mkdir('/app/2')
+    build.run('echo 427911 > /app/1/VERSION')
+    build.run('echo 427912 > /app/2/VERSION')
+    build.run('echo 427913 > /tmp/VERSION')
+
+    app = project.derive
+    app.import('/app', from: build)
+
+    b_container = build.last_image.run('cat /tmp/VERSION')
+    b_output = b_container.tap(&:wait).streaming_logs(stdout: true, stderr: true)
+    b_container.remove
+
+    expect(b_output).to eq("427913\n")
+
+    v1_container = app.last_image.run('cat /app/2/VERSION')
+    v1_output = v1_container.tap(&:wait).streaming_logs(stdout: true, stderr: true)
+    v1_container.remove
+
+    expect(v1_output).to eq("427912\n")
+
+    v2_container = app.last_image.run('cat /tmp/VERSION')
+    v2_output = v2_container.tap(&:wait).streaming_logs(stdout: true, stderr: true)
+    v2_container.remove
+
+    expect(v2_output).to include("'/tmp/VERSION': No such file or directory")
+  end
+
+end

data/spec/drydock/project_spec.rb

@@ -0,0 +1,156 @@
+
+RSpec.describe Drydock::Project do
+
+  let(:project) { described_class.new }
+  after(:each) { project.destroy!(force: true) if project }
+
+  let(:asset_path) { 'spec/assets' }
+
+  it 'require a `from` before a `run`' do
+    expect { project.run('ls /') }.to raise_error(Drydock::InvalidInstructionError)
+  end
+
+  it 'require only one `from` per project' do
+    expect { project.from('alpine') }.not_to raise_error
+    expect { project.from('alpine') }.to raise_error(Drydock::InvalidInstructionError)
+  end
+
+  it 'sets no extra information on image commit' do
+    expect { project.from('alpine') }.not_to raise_error
+    expect { project.run('ls /')    }.not_to raise_error
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Author']).to eq('')
+  end
+
+  it 'sets the author after an image commit' do
+    name = 'John Doe'
+    email = 'john@doe.int'
+    author = 'John Doe <john@doe.int>'
+
+    project.from('alpine')
+    project.author(name: name, email: email)
+
+    expect { project.run('ls /') }.not_to raise_error
+    expect(project.last_image).not_to be_nil
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Author']).to eq(author)
+  end
+
+  it 'build ID is incremented at every build step' do
+    expect(project.build_id).to eq('0')
+
+    project.from('alpine')
+    expect(project.build_id).to eq('1')
+  end
+
+  it 'copies asset files into an image' do
+    project.from('alpine')
+    expect { project.copy(asset_path, '/', chmod: false, no_cache: true, recursive: true) }.not_to raise_error
+
+    expect(project.last_image).not_to be_nil
+    expect(project.last_image.id).not_to be_empty
+
+    hash_container = project.last_image.run('sha1sum /spec/assets/hello-world.txt')
+    hash_output = hash_container.tap(&:wait).streaming_logs(stdout: true, stderr: true)
+    hash_container.remove
+
+    expect(hash_output).to include('60fde9c2310b0d4cad4dab8d126b04387efba289')
+  end
+
+  it 'autocreates the target path on copy' do
+    project.from('alpine')
+    expect {
+      project.copy(asset_path, '/assets', chmod: false, no_cache: true, recursive: true)
+    }.to raise_error(Drydock::InvalidInstructionError)
+
+    expect(project.last_image).to be_nil
+  end
+
+  it 'downloads from the source URL once' do
+    expect(Excon).to receive(:get).once.with('http://httpbin.org/ip', hash_including(:response_block))
+
+    project.set :cache, Drydock::ObjectCaches::InMemoryCache.new
+    project.from('alpine')
+    expect {
+      project.download_once('http://httpbin.org/ip', '/etc/ip_address.json',   chmod: 0600)
+      project.download_once('http://httpbin.org/ip', '/etc/ip_address_2.json', chmod: 0600)
+    }.not_to raise_error
+  end
+
+  it 'sets the raw Cmd' do
+    project.from('alpine')
+    project.cmd(['/bin/bash'])
+
+    expect(project.last_image).not_to be_nil
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Config']['Cmd']).to eq(['/bin/bash'])
+  end
+
+  it 'sets the shell Cmd' do
+    project.from('alpine')
+    project.cmd('/bin/ls')
+
+    expect(project.last_image).not_to be_nil
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Config']['Cmd']).to eq(['/bin/sh', '-c', '/bin/ls'])
+  end
+
+  it 'keeps the shell Cmd even after another build command' do
+    project.from('alpine')
+    project.cmd('/bin/ls')
+    project.run('/bin/date')
+
+    expect(project.last_image).not_to be_nil
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Config']['Cmd']).to eq(['/bin/sh', '-c', '/bin/ls'])
+    expect(image.info['ContainerConfig']['Cmd']).to eq(['/bin/sh', '-c', '/bin/date'])
+  end
+
+  it 'sets the Env' do
+    project.from('alpine')
+    project.env('APP_ROOT_TEST', '/app/current')
+
+    expect(project.last_image).not_to be_nil
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Config']['Env']).to include('APP_ROOT_TEST=/app/current')
+  end
+
+  it 'sets the Env with multiple values' do
+    project.from('alpine')
+    project.env('APP_ROOT_TEST', '/app/current')
+    project.env('BUILD_ROOT',    '/tmp/build')
+
+    expect(project.last_image).not_to be_nil
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Config']['Env']).to include('APP_ROOT_TEST=/app/current')
+    expect(image.info['Config']['Env']).to include('BUILD_ROOT=/tmp/build')
+  end
+
+  it 'sets the ExposedPorts' do
+    project.from('alpine')
+    project.expose(tcp: [80, 443], udp: 53)
+
+    expect(project.last_image).not_to be_nil
+
+    image = Docker::Image.get(project.last_image.id)
+    expect(image).not_to be_nil
+    expect(image.info['Config']['ExposedPorts']).to include('80/tcp')
+    expect(image.info['Config']['ExposedPorts']).to include('443/tcp')
+    expect(image.info['Config']['ExposedPorts']).to include('53/udp')
+  end
+
+end

data/spec/drydock/runtime_options_spec.rb

@@ -0,0 +1,31 @@
+
+RSpec.describe Drydock::RuntimeOptions do
+
+  describe '.parse!' do
+    it 'accepts build options' do
+      opts = described_class.parse!(%w{--no-cache -i test.rb -q})
+      expect(opts.cache).to be_falsey
+      expect(opts.includes).to include('test.rb')
+      expect(opts.log_level).to eq(Logger::ERROR)
+    end
+
+    it 'accepts extra build arguments' do
+      opts = described_class.parse!(%w{--build-opts version=2.0.3 --build-opts validate=true})
+
+      expect(opts.build_opts['version']).to eq('2.0.3')
+      expect(opts.build_opts[:version]).to  eq('2.0.3')
+      expect(opts.build_opts[:validate]).to eq('true')
+    end
+
+    it 'converts timeout to integer' do
+      opts = described_class.parse!(%w{--timeout 20})
+      expect(opts.read_timeout).to eq(20)
+    end
+
+    it 'allows one to enable debug mode' do
+      opts = described_class.parse!(%w{--verbose})
+      expect(opts.log_level).to eq(Logger::DEBUG)
+    end
+  end
+
+end

data/spec/drydock/stream_monitor_spec.rb

@@ -0,0 +1,41 @@
+
+RSpec.describe Drydock::StreamMonitor do
+  let(:events)  { Array.new }
+  let(:handler) { lambda { |evt, is_new, serial, evt_type| events << evt } }
+  let(:monitor) { described_class.new(handler) }
+
+  after(:each) do
+    monitor.kill
+    monitor.join
+  end
+
+  describe '#alive?' do
+    subject { monitor.alive? }
+    it { is_expected.to be_truthy }
+  end
+
+  describe 'scenario' do
+    let(:image) { Docker::Image.create(fromImage: 'alpine', tag: 'latest') }
+    let(:container) { image.run('ls -l').tap(&:wait) }
+    let(:run_image) { container.commit }
+
+    after(:each) do
+      container.remove
+      run_image.remove
+    end
+
+    it 'receives the precise number of events' do
+      expect(events).to have(0).items
+
+      expect(monitor).not_to be_nil
+      expect(run_image).not_to be_nil
+
+      expect(events).to have(5).items
+
+      commit_event = events.find { |evt| evt.status == 'commit' }
+      expect(commit_event).not_to be_nil
+      expect(commit_event.id).to eq(container.id)
+    end
+  end
+  
+end