kontena-cli 0.13.4 → 0.14.0

data/spec/kontena/cli/app/yaml/reader_spec.rb

@@ -0,0 +1,249 @@
+require_relative '../../../../spec_helper'
+require 'kontena/cli/apps/yaml/reader'
+
+describe Kontena::Cli::Apps::YAML::Reader do
+  include FixturesHelpers
+
+  def absolute_yaml_path(file = 'kontena.yml')
+    "#{Dir.pwd}/#{file}"
+  end
+
+  let(:subject) do
+    described_class.new('kontena.yml')
+  end
+
+  let(:service_extender) do
+    spy
+  end
+
+  let(:valid_result) do
+    {
+      'wordpress' => {
+        'extends' => {
+          'file' => 'docker-compose.yml',
+          'service' => 'wordpress'
+        },
+        'image' => 'wordpress:4.1',
+        'ports' => ['80:80'],
+        'links' => ['mysql:mysql'],
+        'stateful' => true,
+        'environment' => ['WORDPRESS_DB_PASSWORD=test_secret'],
+        'instances' => 2,
+        'deploy' => { 'strategy' => 'ha' },
+        'secrets' => []
+      },
+      'mysql' => {
+        'extends' => {
+          'file' => 'docker-compose.yml',
+          'service' => 'mysql'
+        },
+        'image' => 'mysql:5.6',
+        'stateful' => true,
+        'environment' => ['MYSQL_ROOT_PASSWORD=test_secret'],
+        'secrets' => []
+      }
+    }
+  end
+
+  let(:valid_v2_result) do
+    {
+      'version' => '2',
+      'services' => {
+        'wordpress' => {
+          'image' => 'wordpress:4.1',
+          'ports' => ['80:80'],
+          'depends_on' => ['mysql'],
+          'stateful' => true,
+          'environment' => ['WORDPRESS_DB_PASSWORD=test_secret'],
+          'instances' => 2,
+          'deploy' => { 'strategy' => 'ha' },
+          'networks' => ['front-tier', 'back-tier'],
+          'secrets' => []
+        },
+        'mysql' => {
+          'image' => 'mysql:5.6',
+          'stateful' => true,
+          'environment' => ['MYSQL_ROOT_PASSWORD=test_secret'],
+          'volumes' => ['mysql-data:/var/lib/mysql'],
+          'networks' => ['back-tier'],
+          'secrets' => []
+        }
+      },
+      'volumes' => {
+        'mysql-data' => { 'driver' => 'local' }
+      },
+      'networks' => {
+        'front-tier' => { 'driver' => 'bridge' },
+        'back-tier' => { 'driver' => 'bridge' }
+      }
+    }
+  end
+
+  describe '#initialize' do
+    before(:each) do
+      allow(File).to receive(:read)
+        .with(absolute_yaml_path('kontena.yml'))
+        .and_return(fixture('kontena.yml'))
+      allow(File).to receive(:read)
+        .with(absolute_yaml_path('docker-compose.yml'))
+        .and_return(fixture('docker-compose.yml'))
+    end
+
+    it 'reads given file' do
+      expect(File).to receive(:read)
+        .with(absolute_yaml_path)
+        .and_return(fixture('kontena.yml'))
+      subject
+    end
+
+    context 'variable interpolation' do
+      before(:each) do
+        allow(ENV).to receive(:key?).and_return(true)
+        allow(ENV).to receive(:[]).with('TAG').and_return('4.1')
+        allow(ENV).to receive(:[]).with('project').and_return('test')
+        allow(ENV).to receive(:[]).with('grid').and_return('test-grid')
+        allow(ENV).to receive(:[]).with('MYSQL_IMAGE').and_return('mariadb:latest')
+      end
+
+      it 'interpolates $VAR variables' do
+        allow(File).to receive(:read)
+          .with(absolute_yaml_path)
+          .and_return(fixture('kontena-with-variables.yml'))
+        services = subject.yaml
+        expect(services['wordpress']['image']).to eq('wordpress:4.1')
+      end
+
+      it 'interpolates ${VAR} variables' do
+        allow(File).to receive(:read)
+          .with(absolute_yaml_path)
+          .and_return(fixture('kontena-with-variables.yml'))
+        services = subject.yaml
+        expect(services['mysql']['image']).to eq('mariadb:latest')
+      end
+
+      it 'warns about empty variables' do
+        allow(File).to receive(:read)
+          .with(absolute_yaml_path)
+          .and_return(fixture('kontena-with-variables.yml'))
+        allow(ENV).to receive(:key?)
+          .with('MYSQL_IMAGE')
+          .and_return(false)
+
+        expect {
+          subject
+        }.to output('The MYSQL_IMAGE is not set. Substituting an empty string.
+').to_stdout
+      end
+    end
+
+    it 'replaces $$VAR variables to $VAR format' do
+      allow(ENV).to receive(:key?).and_return(true)
+      allow(ENV).to receive(:[]).with('TAG').and_return('4.1')
+      allow(ENV).to receive(:[]).with('MYSQL_IMAGE').and_return('mariadb:latest')
+      allow(ENV).to receive(:[]).with('project').and_return('test')
+      allow(ENV).to receive(:[]).with('grid').and_return('test-grid')
+      allow(File).to receive(:read)
+        .with(absolute_yaml_path)
+        .and_return(fixture('kontena-with-variables.yml'))
+      services = subject.execute[:services]
+      expect(services['mysql']['environment'].first).to eq('INTERNAL_VAR=$INTERNAL_VAR')
+    end
+  end
+
+  describe '#v2?' do
+    context 'version 1' do
+      it 'returns false' do
+        allow(File).to receive(:read)
+          .with(absolute_yaml_path('docker-compose.yml'))
+          .and_return(fixture('docker-compose.yml'))
+        allow(File).to receive(:read)
+          .with(absolute_yaml_path('kontena.yml'))
+          .and_return(fixture('kontena.yml'))
+        expect(subject.v2?).to be_falsey
+      end
+    end
+    context 'version 2' do
+      it 'returns true' do
+        allow(File).to receive(:read)
+          .with(absolute_yaml_path('docker-compose_v2.yml'))
+          .and_return(fixture('docker-compose_v2.yml'))
+        allow(File).to receive(:read)
+          .with(absolute_yaml_path('kontena.yml'))
+          .and_return(fixture('kontena_v2.yml'))
+        expect(subject.v2?).to be_truthy
+      end
+    end
+  end
+
+  describe '#execute' do
+    before(:each) do
+      allow(ENV).to receive(:[]).with('project').and_return('test')
+      allow(ENV).to receive(:[]).with('grid').and_return('test-grid')
+
+      allow(File).to receive(:read)
+        .with(absolute_yaml_path('kontena.yml'))
+        .and_return(fixture('kontena.yml'))
+      allow(File).to receive(:read)
+        .with(absolute_yaml_path('docker-compose.yml'))
+        .and_return(fixture('docker-compose.yml'))
+    end
+
+    it 'extends services' do
+      docker_compose_yml = YAML.load(fixture('docker-compose.yml') % { project: 'test' })
+      wordpress_options = {
+        'extends' => {
+          'file' => 'docker-compose.yml',
+          'service' => 'wordpress'
+        },
+        'stateful' => true,
+        'environment' => ['WORDPRESS_DB_PASSWORD=test_secret'],
+        'instances' => 2,
+        'deploy' => { 'strategy' => 'ha' }
+      }
+      mysql_options = {
+        'extends' => {
+          'file' => 'docker-compose.yml',
+          'service' => 'mysql'
+        },
+        'stateful' => true,
+        'environment' => ['MYSQL_ROOT_PASSWORD=test_secret']
+      }
+      expect(Kontena::Cli::Apps::YAML::ServiceExtender).to receive(:new)
+        .with(wordpress_options)
+        .once
+        .and_return(service_extender)
+      expect(Kontena::Cli::Apps::YAML::ServiceExtender).to receive(:new)
+        .with(mysql_options)
+        .once
+        .and_return(service_extender)
+      expect(service_extender).to receive(:extend).with(docker_compose_yml['wordpress'])
+      expect(service_extender).to receive(:extend).with(docker_compose_yml['mysql'])
+
+      subject.execute
+    end
+
+    context 'environment variables' do
+      it 'converts env hash to array' do
+        result = subject.execute[:services]
+        expect(result['wordpress']['environment']).to eq(['WORDPRESS_DB_PASSWORD=test_secret'])
+      end
+
+      it 'does nothing to env array' do
+        result = subject.execute[:services]
+        expect(result['mysql']['environment']).to eq(['MYSQL_ROOT_PASSWORD=test_secret'])
+      end
+    end
+    it 'returns result hash' do
+      outcome = subject.execute
+      expect(outcome[:services]).to eq(valid_result)
+    end
+
+    it 'returns validation errors' do
+      allow(File).to receive(:read)
+        .with(absolute_yaml_path('kontena.yml'))
+        .and_return(fixture('kontena-invalid.yml'))
+      outcome = subject.execute
+      expect(outcome[:errors].size).to eq(1)
+    end
+  end
+end

data/spec/kontena/cli/app/yaml/service_extender_spec.rb

@@ -0,0 +1,104 @@
+require_relative '../../../../spec_helper'
+require 'kontena/cli/apps/yaml/service_extender'
+
+describe Kontena::Cli::Apps::YAML::ServiceExtender do
+  let(:options) do
+    {
+      'image' => 'alpine:latest',
+      'ports' => '80:80'
+    }
+  end
+
+  let(:parent_options) do
+    {
+      'build' => '.'
+    }
+  end
+
+  describe '#extend' do
+    it 'merges options' do
+      result = described_class.new(options).extend(parent_options)
+      expected_result = {
+        'image' => 'alpine:latest',
+        'build' => '.',
+        'ports' => '80:80',
+        'environment' => [],
+        'secrets' => []
+      }
+      expect(result).to eq(expected_result)
+    end
+
+    context 'environment variables' do
+      it 'inherites env vars from upper level' do
+        from = { 'environment' => ['FOO=bar'] }
+        to = {}
+        result = described_class.new(to).extend(from)
+        expect(result['environment']).to eq(['FOO=bar'])
+      end
+
+      it 'overrides values' do
+        from = { 'environment' => ['FOO=bar'] }
+        to = { 'environment' => ['FOO=baz'] }
+        result = described_class.new(to).extend(from)
+        expect(result['environment']).to eq(['FOO=baz'])
+      end
+
+      it 'combines variables' do
+        from = { 'environment' => ['FOO=bar'] }
+        to = { 'environment' => ['BAR=baz'] }
+        result = described_class.new(to).extend(from)
+        expect(result['environment']).to eq(['BAR=baz', 'FOO=bar'])
+      end
+    end
+
+    context 'secrets' do
+      it 'inherites secrets from upper level' do
+        secret = {
+          'secret' => 'CUSTOMER_DB_PASSWORD',
+          'name' => 'MYSQL_PASSWORD',
+          'type' => 'env'
+        }
+        from = { 'secrets' => [secret] }
+        to = {}
+        result = described_class.new(to).extend(from)
+        expect(result['secrets']).to eq([secret])
+      end
+
+      it 'overrides secrets' do
+        from_secret = {
+          'secret' => 'CUSTOMER_DB_PASSWORD',
+          'name' => 'MYSQL_PASSWORD',
+          'type' => 'env'
+        }
+
+        to_secret = {
+          'secret' => 'CUSTOMER_DB_PASSWORD',
+          'name' => 'MYSQL_ROOT_PASSWORD',
+          'type' => 'env'
+        }
+        from = { 'secrets' => [from_secret] }
+        to = { 'secrets' => [to_secret] }
+        result = described_class.new(to).extend(from)
+        expect(result['secrets']).to eq([to_secret])
+      end
+
+      it 'combines secrets' do
+        from_secret = {
+          'secret' => 'CUSTOMER_DB_PASSWORD',
+          'name' => 'MYSQL_PASSWORD',
+          'type' => 'env'
+        }
+
+        to_secret = {
+          'secret' => 'CUSTOMER_API_TOKEN',
+          'name' => 'API_TOKEN',
+          'type' => 'env'
+        }
+        from = { 'secrets' => [from_secret] }
+        to = { 'secrets' => [to_secret] }
+        result = described_class.new(to).extend(from)
+        expect(result['secrets']).to eq([to_secret, from_secret])
+      end
+    end
+  end
+end

data/spec/kontena/cli/app/yaml/validator_spec.rb

@@ -0,0 +1,263 @@
+require_relative '../../../../spec_helper'
+require 'kontena/cli/apps/yaml/validator'
+
+describe Kontena::Cli::Apps::YAML::Validator do
+  describe '#validate_keys' do
+    it 'returns error on invalid key' do
+      result = subject.validate_keys('name' => 'wordpress')
+      expect(result['name'].size).to eq(1)
+    end
+  end
+
+  describe '#validate_options' do
+    context 'image' do
+      it 'image is optional' do
+        result = subject.validate_options('build' => '.')
+        expect(result.success?).to be_truthy
+        expect(result.messages.key?('image')).to be_falsey
+      end
+
+      it 'must be string' do
+        result = subject.validate_options('image' => 10)
+        expect(result.success?).to be_falsey
+        expect(result.messages.key?('image')).to be_truthy
+      end    
+    end
+
+    it 'validates stateful is boolean' do
+      result = subject.validate_options('stateful' => 'bool')
+      expect(result.messages.key?('stateful')).to be_truthy
+    end
+
+    it 'validates net is host or bridge' do
+      result = subject.validate_options('net' => 'invalid')
+      expect(result.messages.key?('net')).to be_truthy
+
+      result = subject.validate_options('net' => 'bridge')
+      expect(result.messages.key?('net')).to be_falsey
+
+      result = subject.validate_options('net' => 'host')
+      expect(result.messages.key?('net')).to be_falsey
+    end
+
+    context 'affinity' do
+      it 'is optional' do
+        result = subject.validate_options({})
+        expect(result.messages.key?('affinity')).to be_falsey
+      end
+
+      it 'must be array' do
+        result = subject.validate_options('affinity' => 'node==node1')
+        expect(result.messages.key?('affinity')).to be_truthy
+        result = subject.validate_options('affinity' => ['node==node1'])
+        expect(result.messages.key?('affinity')).to be_falsey
+      end
+
+      it 'validates format' do
+        result = subject.validate_options('affinity' => ['node=node1'])
+        expect(result.messages.key?('affinity')).to be_truthy
+
+        result = subject.validate_options('affinity' => ['node==node1', 'service!=mariadb'])
+        expect(result.messages.key?('affinity')).to be_falsey
+      end
+    end
+
+    context 'command' do
+      it 'is optional' do
+        result = subject.validate_options({})
+        expect(result.messages.key?('command')).to be_falsey
+      end
+
+      it 'must be string or empty' do
+        result = subject.validate_options('command' => 1234)
+        expect(result.messages.key?('command')).to be_truthy
+
+        result = subject.validate_options('command' => nil)
+        expect(result.messages.key?('command')).to be_falsey
+
+        result = subject.validate_options('command' => 'bundle exec rails s')
+        expect(result.messages.key?('command')).to be_falsey
+      end
+    end
+
+    it 'validates cpu_shares is integer' do
+      result = subject.validate_options('cpu_shares' => '1m')
+      expect(result.messages.key?('cpu_shares')).to be_truthy
+      result = subject.validate_options('cpu_shares' => 1024)
+      expect(result.messages.key?('cpu_shares')).to be_falsey
+      result = subject.validate_options({})
+      expect(result.messages.key?('cpu_shares')).to be_falsey
+    end
+
+    it 'validates environment is array or hash' do
+      result = subject.validate_options('environment' => 'KEY=VALUE')
+      expect(result.messages.key?('environment')).to be_truthy
+      result = subject.validate_options('environment' => ['KEY=VALUE'])
+      expect(result.messages.key?('environment')).to be_falsey
+      result = subject.validate_options('environment' => { 'KEY' => 'VALUE' })
+      expect(result.messages.key?('environment')).to be_falsey
+    end
+
+    context 'validates secrets' do
+      it 'must be array' do
+        result = subject.validate_options('secrets' => {})
+        expect(result.messages.key?('secrets')).to be_truthy
+      end
+
+      context 'item' do
+        it 'must contain secret' do
+          result = subject.validate_options('secrets' => [{ 'name' => 'test', 'type' => 'env' }])
+          expect(result.messages.key?('secrets')).to be_truthy
+        end
+
+        it 'must contain name' do
+          result = subject.validate_options('secrets' => [{ 'secret' => 'test', 'type' => 'env' }])
+          expect(result.messages.key?('secrets')).to be_truthy
+        end
+
+        it 'must contain type' do
+          result = subject.validate_options('secrets' => [{ 'secret' => 'test', 'name' => 'test' }])
+          expect(result.messages.key?('secrets')).to be_truthy
+        end
+
+        it 'accepts valid input' do
+          result = subject.validate_options('secrets' =>
+            [
+              {
+                'secret' => 'test',
+                'name' => 'test',
+                'type' => 'env'
+              }
+            ])
+          expect(result.messages.key?('secrets')).to be_falsey
+        end
+      end
+    end
+
+    context 'validates hooks' do
+      context 'validates pre_build' do
+        it 'must be array' do
+          result = subject.validate_options('hooks' => { 'pre_build' => {} })
+          expect(result.messages.key?('hooks')).to be_truthy
+          data = {
+            'hooks' => {
+              'pre_build' => [
+                {
+                  'cmd' => 'rake db:migrate'
+                }
+              ]
+            }
+          }
+          result = subject.validate_options(data)
+          expect(result.messages.key?('hooks')).to be_falsey
+        end
+      end
+      context 'validates post_start' do
+        it 'must be array' do
+          result = subject.validate_options('hooks' => { 'post_start' => {} })
+          expect(result.messages.key?('hooks')).to be_truthy
+          data = {
+            'hooks' => {
+              'post_start' => [
+                {
+                  'name' => 'migrate',
+                  'cmd' => 'rake db:migrate',
+                  'instances' => '*'
+                }
+              ]
+            }
+          }
+          result = subject.validate_options(data)
+          expect(result.messages.key?('hooks')).to be_falsey
+        end
+
+        context 'item' do
+          it 'must contain name' do
+            result = subject.validate_options('hooks' =>
+            {
+              'post_start' => [
+                {
+                  'cmd' => 'rake db:migrate',
+                  'instances' => '1'
+                }
+              ]
+            })
+            expect(result.messages.key?('hooks')).to be_truthy
+          end
+
+          it 'must contain cmd' do
+            result = subject.validate_options('hooks' =>
+            {
+              'post_start' => [
+                {
+                  'name' => 'migrate',
+                  'instances' => '1'
+                }
+              ]
+            })
+            expect(result.messages.key?('hooks')).to be_truthy
+          end
+
+          it 'must contain instance number or *' do
+            result = subject.validate_options('hooks' =>
+            {
+              'post_start' => [
+                { 'name' => 'migrate',
+                  'cmd' => 'rake db:migrate'
+                }
+              ]
+            })
+            expect(result.messages.key?('hooks')).to be_truthy
+            data = {
+              'hooks' => {
+                'post_start' => [
+                  {
+                    'name' => 'migrate',
+                    'cmd' => 'rake db:migrate',
+                    'instances' => 'all',
+                    'oneshot' => true
+                  }
+                ]
+              }
+            }
+            result = subject.validate_options(data)
+            expect(result.messages.key?('hooks')).to be_truthy
+          end
+
+          it 'may contain boolean oneshot' do
+            data = {
+              'hooks' => {
+                'post_start' => [
+                  {
+                    'name' => 'migrate',
+                    'cmd' => 'rake db:migrate',
+                    'instances' => '*',
+                    'oneshot' => 'true'
+                  }
+                ]
+              }
+            }
+            result = subject.validate_options(data)
+            expect(result.messages.key?('hooks')).to be_truthy
+          end
+        end
+
+        it 'validates volumes is array' do
+          result = subject.validate_options('volumes' => '/app')
+          expect(result.messages.key?('volumes')).to be_truthy
+
+          result = subject.validate_options('volumes' => ['/app'])
+          expect(result.messages.key?('volumes')).to be_falsey
+        end
+
+        it 'validates volumes_from is array' do
+          result = subject.validate_options('volumes_from' => 'mysql_data')
+          expect(result.messages.key?('volumes_from')).to be_truthy
+
+          result = subject.validate_options('volumes_from' => ['mysql_data'])
+          expect(result.messages.key?('volumes_from')).to be_falsey
+        end
+      end
+    end
+  end
+end