lib(): allow usage of generic key in deployment-dependencies

o-orand · o-orand · commit 8423c257f013 · 2018-07-09T16:48:46.000+02:00
We don't remove consistency checks, but it is possible to deactivate it using the `bosh-deployment` generic key. So either a valid `deployment-name` is used, either the generic-key. closes #150
diff --git a/Readme.md b/Readme.md
@@ -323,7 +323,7 @@ In `deployment-dependencies.yml`, it is possible to:
 
 ``` yaml
         deployment:
-          micro-bosh:
+          bosh-deployment: # or micro-bosh:
             cli_version: v1
             releases:
                 ...
@@ -335,7 +335,7 @@ Following is a `deployment-dependencies.yml` sample (should be placed in the bos
 
 ---
 deployment:
-  micro-bosh:
+  bosh-deployment: # or micro-bosh:
     releases:
       route-registrar-boshrelease:
         base_location: https://bosh.io/d/github.com/
@@ -350,6 +350,9 @@ deployment:
       smoke_tests:
 ```
 
+Staring with COA [2.2](https://github.com/orange-cloudfoundry/cf-ops-automation/releases/tag/v2.2.0), it is possible to use
+a generic key (`bosh-deployment`) or `<deployment-name>` (ie: the directory name) under `deployment`
+
 ### Cloudfoundry application resources template format
 
 For each cf-application, when a `enable-cf-app.yml` file is found, it is going to spruce all files in the template dir ending with ```-tpl.yml```
@@ -574,7 +577,7 @@ run `./init-template.sh`, and it creates empty placeholder.
 
 ---
 deployment:
-  micro-bosh:
+  bosh-deployment: #or micro-bosh:
     releases:
       route-registrar-boshrelease:
         base_location: https://bosh.io/d/github.com/
diff --git a/docs/reference_dataset/template_repository/another-world-root-depls/another-bosh-deployment-sample/deployment-dependencies.yml b/docs/reference_dataset/template_repository/another-world-root-depls/another-bosh-deployment-sample/deployment-dependencies.yml
@@ -1,6 +1,6 @@
 ---
 deployment:
-  nginx:
+  bosh-deployment:
     releases:
       nginx:
         base_location: https://bosh.io/d/github.com/
diff --git a/docs/reference_dataset/template_repository/hello-world-root-depls/bosh-deployment-sample/deployment-dependencies.yml b/docs/reference_dataset/template_repository/hello-world-root-depls/bosh-deployment-sample/deployment-dependencies.yml
@@ -1,8 +1,8 @@
 ---
 deployment:
-  bosh-deployment-sample:
-    # DEPRECATED: uncomment next line to use bosh_cli v1 to deploy manifest
-    # cli_version: v1
+  bosh-deployment: # prior to COA 2.2, this tag must be named like the deployment (here bosh-deployment-sample),
+                   # after COA 2.2, it is possible to use 'bosh-deployment' key
+    # cli_version: v1 # DEPRECATED: uncomment to use bosh_cli v1 to deploy manifest
     resources:
       secrets:
         # DEPRECATED: this deployment depends on another secrets deployment, so it also have to scan change onto the other one
diff --git a/docs/reference_dataset/template_repository/hello-world-root-depls/cf-apps-deployments/generic-app/deployment-dependencies.yml b/docs/reference_dataset/template_repository/hello-world-root-depls/cf-apps-deployments/generic-app/deployment-dependencies.yml
@@ -1,4 +1,4 @@
 ---
 deployment:
-  generic-app:
+  bosh-deployment:
     releases: {}
diff --git a/docs/reference_dataset/template_repository/hello-world-root-depls/pipeline-sample/deployment-dependencies.yml b/docs/reference_dataset/template_repository/hello-world-root-depls/pipeline-sample/deployment-dependencies.yml
@@ -1,4 +1,4 @@
 ---
 deployment:
-  pipeline-sample:
+  bosh-deployment:
     releases: {}
diff --git a/lib/deployment.rb b/lib/deployment.rb
@@ -28,11 +28,13 @@ def disable
   end
 
   def self.default(deployment_name)
-    details = {
+    Deployment.new(deployment_name, default_details)
+  end
+
+  def self.default_details
+    {
       'stemcells' => {},
       'releases' => {}
     }
-
-    Deployment.new(deployment_name, details)
   end
 end
diff --git a/lib/deployment_factory.rb b/lib/deployment_factory.rb
@@ -14,28 +14,19 @@ def initialize(root_deployment_name, version_reference = {}, config = Config.new
     validate_version_reference
   end
 
-  def load_file(filename)
-    raise 'invalid filename. Cannot be nil' if filename.nil?
-    raise "file not found: #{filename}" unless File.exist?(filename)
-    puts "processing #{filename}"
+  def load_file(filename = '')
+    validate_file(filename)
+    puts "DeploymentFactory - processing #{filename}"
+    deployment_name = File.dirname(filename)&.split(File::SEPARATOR)&.last
     yaml_file = YAML.load_file(filename) || {}
-    load(yaml_file)
-  end
-
-  def load(data = {})
-    raise "invalid data. Cannot load 'nil' data" if data.nil?
-    deployments = []
-    data['deployment']&.each do |deployment_name, deployment_details|
-      update_deployment_details(deployment_details)
-      deployments << Deployment.new(deployment_name, deployment_details)
-    end
-    raise "Invalid data. Missing root: 'deployment' or '<deployment_name>'" if deployments.empty?
-    deployments
+    load(deployment_name, yaml_file)
   end
 
-  def update_deployment_details(deployment_details)
-    update_boshrelease_version(deployment_details)
-    add_stemcell_info(deployment_details)
+  def load(deployment_name = '', data = {})
+    raise "invalid deployment_name. Cannot be empty" if deployment_name.empty?
+    raise "invalid data. Cannot load empty data" if data.empty?
+    deployment_info = load_deployment_info(data)
+    process_deployment_info(deployment_info, deployment_name)
   end
 
   def stemcell_name
@@ -48,6 +39,32 @@ def stemcell_version
 
   private
 
+  def validate_file(filename)
+    raise 'invalid filename. Cannot be empty' if filename.to_s.empty?
+    raise "file not found: #{filename}" unless File.exist?(filename)
+  end
+
+  def process_deployment_info(deployment_info, deployment_name)
+    deployments = []
+    deployment_info.each do |current_deployment_name, deployment_details|
+      raise "Invalid deployment_name: expected <#{deployment_name}> or <bosh-deployment> - Found <#{current_deployment_name}> " unless deployment_name == current_deployment_name || current_deployment_name == 'bosh-deployment'
+      update_deployment_details(deployment_details)
+      deployments << Deployment.new(deployment_name, deployment_details)
+    end
+    deployments
+  end
+
+  def load_deployment_info(data)
+    deployment_info = data['deployment'] || {}
+    raise "Invalid data. Missing root: 'deployment'" if deployment_info.empty?
+    deployment_info
+  end
+
+  def update_deployment_details(deployment_details)
+    update_boshrelease_version(deployment_details)
+    add_stemcell_info(deployment_details)
+  end
+
   def add_stemcell_info(deployment_details)
     return if deployment_details.nil?
     deployment_details['stemcells'] = { stemcell_name => {} }
diff --git a/lib/directory_initializer.rb b/lib/directory_initializer.rb
@@ -7,6 +7,8 @@
 class DirectoryInitializer
   attr_reader :root_deployment_name, :secrets_dir, :template_dir
 
+  DEFAULT_DEPLOYMENT_DEPENDENCIES_CONTENT = { 'deployment' => { 'bosh-deployment' => Deployment.default_details } }.freeze
+
   def initialize(root_deployment_name, secrets_dir, template_dir, terraform_dir = '')
     @root_deployment_name = root_deployment_name
     @secrets_dir = secrets_dir
@@ -44,7 +46,7 @@ def setup_templates!
     create_non_existing_files files_to_create
   end
 
-  def add_deployment(deployment_name)
+  def add_deployment(deployment_name, deployment_dependencies_content = DEFAULT_DEPLOYMENT_DEPENDENCIES_CONTENT)
     dirs_to_create = files_to_create = []
 
     dirs_to_create << "#{@template_dir}/#{@root_deployment_name}/#{deployment_name}"
@@ -56,7 +58,7 @@ def add_deployment(deployment_name)
     files_to_create << "#{@secrets_dir}/#{@root_deployment_name}/#{deployment_name}/secrets/secrets.yml"
     create_non_existing_files files_to_create
 
-    generate_default_bosh_deployment_dependencies(deployment_name)
+    generate_default_bosh_deployment_dependencies(deployment_name, deployment_dependencies_content)
   end
 
   def enable_deployment(deployment_name)
@@ -73,11 +75,9 @@ def disable_deployment(deployment_name)
 
   private
 
-  def generate_default_bosh_deployment_dependencies(deployment_name)
-    deployment = Deployment.default(deployment_name)
+  def generate_default_bosh_deployment_dependencies(deployment_name, deployment_dependencies_content)
     filename = File.join(@template_dir, @root_deployment_name, deployment_name, 'deployment-dependencies.yml')
-    file_content = { 'deployment' => { deployment_name => deployment.details } }
-    File.open(filename, 'w') { |file| file << YAML.dump(file_content) }
+    File.open(filename, 'w') { |file| file << YAML.dump(deployment_dependencies_content) }
   end
 
   def generate_empty_map_yaml(filename)
diff --git a/lib/root_deployment.rb b/lib/root_deployment.rb
@@ -29,9 +29,7 @@ def overview_from_hash(deployment_factory)
       deployment = if File.exist?(enable_deployment_file)
                      base_location = File.join(@dependency_root_path, @root_deployment_name, dirname)
                      deployers_config = DeploymentDeployersConfig.new(dirname, base_location, filename, deployment_factory)
-                     deployment = deployers_config.load_configs
-                     raise "#{filename} - Invalid deployment: expected <#{dirname}> - Found <#{deployment.name}>" if deployment.name != dirname
-                     deployment
+                     deployers_config.load_configs
                    else
                      puts "Deployment #{dirname} is inactive"
                      Deployment.new(dirname).disable
diff --git a/scripts/init-template.sh b/scripts/init-template.sh
@@ -49,16 +49,16 @@ touch ${DEPLOYMENT_TYPE}/${DEPLOYMENT_NAME}/template/${DEPLOYMENT_NAME}-tpl.yml
 
 echo "Creating dummy deployment-dependencies-sample.yml"
 target=${DEPLOYMENT_TYPE}/${DEPLOYMENT_NAME}/deployment-dependencies-sample.yml
-echo "---" >$target
-echo "deployment:" >>$target
-echo "  ${DEPLOYMENT_NAME}:" >>$target
-echo "    stemcells:" >>$target
-echo "      bosh-openstack-kvm-ubuntu-trusty-go_agent:" >>$target
-echo "    releases:" >>$target
-echo "      xxx_boshrelease:" >>$target
-echo "        base_location: https://bosh.io/d/github.com/" >>$target
-echo "        repository:" >>$target
-echo "" >>$target
+echo "---" >"${target}"
+{
+    echo "deployment:"
+    echo "  bosh-deployment:"
+    echo "    releases:"
+    echo "      xxx_boshrelease:"
+    echo "        base_location: https://bosh.io/d/github.com/"
+    echo "        repository:"
+    echo ""
+} >>"${target}"
 
 echo "####### WARNING #########"
 echo "Don't forget to  rename ${DEPLOYMENT_TYPE}/${DEPLOYMENT_TYPE}/deployment-dependencies-sample.yml to ${DEPLOYMENT_TYPE}/${DEPLOYMENT_TYPE}/deployment-dependencies.yml when you're done !"
diff --git a/spec/lib/deployment_factory_spec.rb b/spec/lib/deployment_factory_spec.rb
@@ -48,7 +48,7 @@
       it 'raises an error about stemcell-name' do
         allow(config).to receive(:stemcell_name).and_return('')
 
-        expect { subject }.to raise_error(RuntimeError) { |error| expect(error.message).to match('invalid config: missing stemcell, expected: a config with a stemcell name defined') }
+        expect { subject }.to raise_error(RuntimeError, /invalid config: missing stemcell, expected: a config with a stemcell name defined/ )
       end
     end
   end
@@ -58,7 +58,7 @@
       subject { described_class.new(root_deployment_name, versions, config).load_file 'dummy-filename.yml' }
 
       it 'raise an error' do
-        expect { subject }.to raise_error(RuntimeError) { |error| expect(error.message).to match('file not found: dummy-filename.yml') }
+        expect { subject }.to raise_error(RuntimeError, /file not found: dummy-filename.yml/)
 
       end
     end
@@ -67,7 +67,7 @@
       subject { described_class.new(root_deployment_name, versions, config).load_file nil }
 
       it 'raise an error' do
-        expect { subject }.to raise_error(RuntimeError) { |error| expect(error.message).to match('invalid filename. Cannot be nil') }
+        expect { subject }.to raise_error(RuntimeError, /invalid filename. Cannot be empty/)
 
       end
     end
@@ -76,34 +76,61 @@
       subject { described_class.new(root_deployment_name, versions, config).load_file '' }
 
       it 'raise an error' do
-        expect { subject }.to raise_error(RuntimeError) { |error| expect(error.message).to match('file not found: ') }
-
+        expect { subject }.to raise_error(RuntimeError, /invalid filename. Cannot be empty/)
       end
     end
   end
 
   describe '#load' do
-    context 'when data is nil ' do
-      let(:deployment_factory) do
-        described_class.new(
-            root_deployment_name,
-            versions
-        )
+    let(:deployment_factory) do
+      described_class.new(
+          root_deployment_name,
+          versions
+      )
+    end
+
+    context 'when data is not set' do
+      it 'raise an error' do
+        expect { deployment_factory.load(deployment_name) }.to raise_error(RuntimeError, /invalid data. Cannot load empty data/)
       end
+    end
+
+    context 'when data is invalid' do
+      let (:invalid_data) { YAML.load('invalid: true').to_s }
 
       it 'raise an error' do
-        expect { deployment_factory.load(nil) }.to raise_error(RuntimeError) { |error| expect(error.message).to match("invalid data. Cannot load 'nil' data") }
+        expect { deployment_factory.load(deployment_name, invalid_data) }.to raise_error(RuntimeError, /Invalid data. Missing root: 'deployment'/)
       end
     end
 
-    context 'when a deployment does not have any details' do
-      let(:deployment_factory) do
-        described_class.new(
-          root_deployment_name,
-          versions
-        )
+    context 'when deployment_name is not set' do
+      it 'raise an error' do
+        expect { deployment_factory.load }.to raise_error(RuntimeError, /invalid deployment_name. Cannot be empty/)
       end
-      let(:loaded_deployments) { deployment_factory.load('deployment' => { deployment_name => nil }) }
+    end
+
+    context 'when deployment_name does not match yaml content' do
+      let(:ntp_deployment_dependencies_content) { { 'deployment' => { 'ntp' => Deployment.default_details } } }
+
+      it 'raise an error' do
+        expect { deployment_factory.load('my-deployment', ntp_deployment_dependencies_content) }.to raise_error(RuntimeError, /Invalid deployment_name: expected <my-deployment> or <bosh-deployment> - Found <ntp>/)
+      end
+    end
+
+    context 'when deployment dependencies yaml follows COA conventions' do
+      let(:generic_deployment_dependencies_content) { {'deployment' => {'bosh-deployment' => Deployment.default_details } } }
+      let(:deployment_name) { 'my-deployment' }
+      let(:loaded_deployment) { deployment_factory.load(deployment_name, generic_deployment_dependencies_content) }
+      let(:my_deployment) { loaded_deployment.first }
+
+      it 'loads my_deployment' do
+        expect(my_deployment.name).to eq(deployment_name)
+      end
+    end
+
+
+    context 'when a deployment does not have any details' do
+      let(:loaded_deployments) { deployment_factory.load(deployment_name,'deployment' => { deployment_name => nil }) }
 
       it 'creates a deployment object with an empty details field' do
         expect(loaded_deployments.first).to have_attributes(name: deployment_name, details: {})
@@ -117,7 +144,7 @@
           'bosh-openstack-cpi-release-version' => '37' }
       end
       let(:deployment_factory) { described_class.new(root_deployment_name, versions, config) }
-      let(:loaded_deployments) { deployment_factory.load('deployment' => bosh_master_deployment) }
+      let(:loaded_deployments) { deployment_factory.load(deployment_name, 'deployment' => bosh_master_deployment) }
       let(:bosh_master_deployment) do
         my_yaml = <<~YAML
           #{deployment_name}:
diff --git a/spec/lib/root_deployment_spec.rb b/spec/lib/root_deployment_spec.rb
@@ -173,24 +173,5 @@
         expect { overview }.to raise_error(RuntimeError, "Inconsistency detected: deployment <ntp> is marked as active, but no deployment-dependencies.yml, nor other deployer config found at #{File.join(templates, root_deployment_name, 'ntp')}")
       end
     end
-
-    context 'when a deployment name does not match definition directory' do
-      let(:overview) { root_deployment.overview_from_hash(deployment_factory) }
-
-      before do
-        init = dir_init
-        init.add_deployment('ntp')
-        init.enable_deployment('ntp')
-        [templates, secrets].each do |a_dir|
-          deployment_dirname = File.join(a_dir, root_deployment_name, 'ntp')
-          new_deployment_dirname = File.join(a_dir, root_deployment_name, 'dummy')
-          FileUtils.mv(deployment_dirname, new_deployment_dirname) if Dir.exist?(deployment_dirname)
-        end
-      end
-
-      it 'raises an error' do
-        expect { overview }.to raise_error(RuntimeError) { |error| expect(error.message).to match(secrets + '/main_depls/dummy - Invalid deployment: expected <dummy> - Found <ntp>') }
-      end
-    end
   end
 end
diff --git a/spec/scripts/generate-depls/fixtures/templates/no-dependency-depls/bosh/deployment-dependencies.yml b/spec/scripts/generate-depls/fixtures/templates/no-dependency-depls/bosh/deployment-dependencies.yml
@@ -1,4 +1,4 @@
 ---
 deployment:
-  bosh:
+  bosh-deployment:
     releases:
diff --git a/spec/scripts/generate-depls/fixtures/templates/simple-depls/ntp/deployment-dependencies.yml b/spec/scripts/generate-depls/fixtures/templates/simple-depls/ntp/deployment-dependencies.yml
@@ -1,6 +1,6 @@
 ---
 deployment:
-  ntp:
+  bosh-deployment:
     releases:
       ntp_boshrelease:
         base_location: https://bosh.io/d/github.com/
