Update installing of dependencies

* config-server and bosh-agent repos are now required to be cloned at
  the same level as the bosh repo
* Services and binaries are only compiled once

Signed-off-by: Aram Price <[email protected]>

Author: ystros

.gitignore

@@ -14,7 +14,6 @@ dev_releases
 releases/*.tgz
 releases/**/*.tgz
 
-src/bosh-agent/
 src/postgresql.dump.sql
 src/postgresql.tables.txt
 src/parallel_runtime_rspec.log

ci/tasks/test-integration.sh

@@ -10,13 +10,6 @@ start_db "${DB}"
 
 install bosh-cli/*bosh-cli-*-linux-amd64 "/usr/local/bin/bosh"
 
-cp -r bosh-agent "${BOSH_REPO}/src/"
-
-pushd config-server
-  go build .
-  export CONFIG_SERVER_BINARY=$(realpath config-server)
-popd
-
 pushd "${BOSH_REPO}/src"
   print_git_state
   print_ruby_info

src/bosh-director/lib/cloud/dummy.rb

@@ -9,6 +9,8 @@ module Clouds
     class Dummy
       class NotImplemented < StandardError; end
 
+      BOSH_REPO_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', '..'))
+
       attr_reader :commands
       attr_accessor :options
 
@@ -525,7 +527,7 @@ def write_agent_default_network(agent_id, ip_address)
 
       def agent_cmd(agent_id, legacy_agent_path)
         if legacy_agent_path.nil?
-          go_agent_exe =  File.expand_path('../../../../bosh-agent/out/bosh-agent', __FILE__)
+          go_agent_exe =  File.join(BOSH_REPO_ROOT, 'src', 'tmp', 'bin', 'bosh-agent')
         else
           go_agent_exe = legacy_agent_path
         end

src/spec/integration_support/bosh_agent.rb

@@ -1,21 +1,26 @@
+require 'integration_support/constants'
+
 module IntegrationSupport
   module BoshAgent
-    BOSH_REPO_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..')).freeze
-    BOSH_AGENT_SRC = File.join(BOSH_REPO_ROOT, 'src/bosh-agent')
-    COMPILED_BOSH_AGENT = File.join(BOSH_AGENT_SRC, 'out', 'bosh-agent')
+    SOURCE_DIR = File.join(IntegrationSupport::Constants::BOSH_REPO_PARENT_DIR, 'bosh-agent')
+    COMPILED_BOSH_AGENT = File.join(SOURCE_DIR, 'out', 'bosh-agent')
+
+    def self.install
+      return if File.exist?(executable_path)
 
-    def self.ensure_agent_exists!
-      unless File.exist?(COMPILED_BOSH_AGENT) || ENV['TEST_ENV_NUMBER']
-        puts "Building agent in #{COMPILED_BOSH_AGENT}..."
+      raise "The bosh-agent source must be a sibling to the BOSH Director repo" unless File.exist?(SOURCE_DIR)
 
-        raise 'Bosh agent build failed' unless system(File.join(BOSH_AGENT_SRC, 'bin', 'build'))
+      Dir.chdir(SOURCE_DIR) do
+        system('bin/build') || raise('Unable to build bosh-agent')
       end
+      raise 'Expected bosh-agent binary to exist, but it does not' unless File.exist?(COMPILED_BOSH_AGENT)
+
+      FileUtils.cp(COMPILED_BOSH_AGENT, executable_path)
     end
-  end
-end
 
-RSpec.configure do |c|
-  c.before(:suite) do
-    IntegrationSupport::BoshAgent.ensure_agent_exists!
+    def self.executable_path
+      File.join(IntegrationSupport::Constants::INTEGRATION_BIN_DIR, 'bosh-agent')
+    end
   end
 end
+

src/spec/integration_support/config_server_service.rb

@@ -6,7 +6,7 @@ class ConfigServerService
 
     LOCAL_CONFIG_SERVER_FILE_NAME = "bosh-config-server-executable"
 
-    INSTALL_DIR = File.join('tmp', 'integration-config-server')
+    SOURCE_DIR = File.join(IntegrationSupport::Constants::BOSH_REPO_PARENT_DIR, 'config-server')
 
     # Keys and Certs
     CERTS_DIR = File.join(IntegrationSupport::Constants::SANDBOX_ASSETS_DIR, 'config_server', 'certs')
@@ -23,7 +23,7 @@ def initialize(port_provider, base_log_path, logger, test_env_number)
       @port = port_provider.get_port(:config_server_port)
       @logger = logger
       @log_location = "#{base_log_path}.config-server.out"
-      @config_server_config_file= File.join(INSTALL_DIR, "config-server-config#{test_env_number}.json")
+      @config_server_config_file= File.join(IntegrationSupport::Constants::INTEGRATION_BIN_DIR, "config-server-config#{test_env_number}.json")
       @config_server_socket_connector = SocketConnector.new('config-server', 'localhost', @port, @log_location, logger)
 
       @config_server_process = IntegrationSupport::Service.new(
@@ -36,12 +36,25 @@ def initialize(port_provider, base_log_path, logger, test_env_number)
     end
 
     def self.install
-      binary_file_path = ENV.fetch('CONFIG_SERVER_BINARY')
+      return if File.exist?(executable_path)
 
-      FileUtils.mkdir_p(INSTALL_DIR)
-      executable_file_path = File.join(INSTALL_DIR, LOCAL_CONFIG_SERVER_FILE_NAME)
-      FileUtils.copy(binary_file_path, executable_file_path)
-      File.chmod(0777, executable_file_path)
+      binary_file_path = self.build_binary
+      FileUtils.copy(binary_file_path, executable_path)
+    end
+
+    def self.executable_path
+      File.join(IntegrationSupport::Constants::INTEGRATION_BIN_DIR, LOCAL_CONFIG_SERVER_FILE_NAME)
+    end
+
+    def self.build_binary
+      raise "The config-server source must be a sibling to the BOSH Director repo" unless File.exist?(SOURCE_DIR)
+
+      Dir.chdir(SOURCE_DIR) do
+        system('go build .') || raise('Unable to build config-server')
+      end
+      binary_file_path = File.join(SOURCE_DIR, 'config-server')
+      raise 'Expected config-server binary to exist, but it does not' unless File.exist?(binary_file_path)
+      binary_file_path
     end
 
     def start(with_trusted_certs)
@@ -68,7 +81,7 @@ def restart(with_trusted_certs)
     private
 
     def executable_path
-      File.join(INSTALL_DIR, LOCAL_CONFIG_SERVER_FILE_NAME)
+      File.join(IntegrationSupport::Constants::INTEGRATION_BIN_DIR, LOCAL_CONFIG_SERVER_FILE_NAME)
     end
 
     def setup_config_file(with_trusted_certs = true)

src/spec/integration_support/constants.rb

@@ -1,7 +1,9 @@
 module IntegrationSupport
   module Constants
     BOSH_REPO_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
+    BOSH_REPO_PARENT_DIR = File.expand_path(File.join(BOSH_REPO_ROOT, '..'))
     BOSH_REPO_SRC_DIR = File.join(BOSH_REPO_ROOT, 'src')
+    INTEGRATION_BIN_DIR = File.join(BOSH_REPO_SRC_DIR, 'tmp', 'bin')
 
     SANDBOX_ASSETS_DIR = File.join(BOSH_REPO_SRC_DIR, 'spec', 'assets', 'sandbox')
     SANDBOX_CERTS_DIR = File.join(SANDBOX_ASSETS_DIR, 'ca', 'certs')

src/spec/integration_support/gnatsd_manager.rb

@@ -1,3 +1,5 @@
+require 'integration_support/constants'
+
 module IntegrationSupport
   class GnatsdManager
     def self.install
@@ -16,11 +18,10 @@ def self.installer
   end
 
   class NatsServerBlobInstaller
-    INSTALL_DIR = File.join(IntegrationSupport::Constants::BOSH_REPO_SRC_DIR, 'tmp', 'integration-nats')
-
     def install
+      return if File.exist?(executable_path)
+
       Dir.chdir(IntegrationSupport::Constants::BOSH_REPO_ROOT) do
-        run_command("mkdir -p #{INSTALL_DIR}")
         run_command('bosh sync-blobs')
         run_command('tar -zxvf blobs/nats/nats-server-*.tar.gz -C /tmp')
         run_command("cp /tmp/nats-server-*/nats-server #{executable_path}")
@@ -29,7 +30,7 @@ def install
     end
 
     def executable_path
-      File.join(INSTALL_DIR, 'nats-server')
+      File.join(IntegrationSupport::Constants::INTEGRATION_BIN_DIR, 'nats-server')
     end
 
     private

src/spec/integration_support/nginx_service.rb

@@ -6,6 +6,8 @@ class NginxService
     CONFIG_TEMPLATE = File.join(IntegrationSupport::Constants::SANDBOX_ASSETS_DIR, 'nginx.conf.erb')
 
     def self.install
+      return if File.exist?(NginxInstaller::EXECUTABLE_PATH)
+
       installer = NginxInstaller.new
       installer.prepare
 
@@ -90,8 +92,7 @@ def logfile_path(base_log_path)
 
   class NginxInstaller
     WORKING_DIR = File.join(IntegrationSupport::Constants::BOSH_REPO_SRC_DIR, 'tmp', 'integration-nginx-work')
-    INSTALL_DIR = File.join(IntegrationSupport::Constants::BOSH_REPO_SRC_DIR, 'tmp', 'integration-nginx')
-    EXECUTABLE_PATH = File.join(INSTALL_DIR, 'sbin', 'nginx')
+    EXECUTABLE_PATH = File.join(IntegrationSupport::Constants::INTEGRATION_BIN_DIR, 'sbin', 'nginx')
 
     def prepare
       Dir.chdir(IntegrationSupport::Constants::BOSH_REPO_ROOT) do
@@ -109,20 +110,18 @@ def should_compile?
     def compile
       # Clean up old compiled nginx bits to stay up-to-date
       FileUtils.rm_rf(WORKING_DIR)
-      FileUtils.rm_rf(INSTALL_DIR)
 
       FileUtils.mkdir_p(WORKING_DIR)
-      FileUtils.mkdir_p(INSTALL_DIR)
 
-      run_command("echo '#{RUBY_PLATFORM}' > #{INSTALL_DIR}/platform")
+      run_command("echo '#{RUBY_PLATFORM}' > #{IntegrationSupport::Constants::INTEGRATION_BIN_DIR}/platform")
 
       # Make sure packaging script has its own blob copies so that blobs/ directory is not affected
       nginx_blobs_path = File.join(IntegrationSupport::Constants::BOSH_REPO_ROOT, 'packages', 'nginx')
       run_command("cp -R #{nginx_blobs_path}/. #{File.join(WORKING_DIR)}")
 
       Dir.chdir(WORKING_DIR) do
         packaging_script_path = File.join(IntegrationSupport::Constants::BOSH_REPO_ROOT, 'packages', 'nginx', 'packaging')
-        run_command("bash #{packaging_script_path}", { 'BOSH_INSTALL_TARGET' => INSTALL_DIR })
+        run_command("bash #{packaging_script_path}", { 'BOSH_INSTALL_TARGET' => IntegrationSupport::Constants::INTEGRATION_BIN_DIR })
       end
     end
 
@@ -150,7 +149,7 @@ def blob_has_changed?
     end
 
     def platform_has_changed?
-      output = run_command("cat #{INSTALL_DIR}/platform || true")
+      output = run_command("cat #{IntegrationSupport::Constants::INTEGRATION_BIN_DIR}/platform || true")
       output != RUBY_PLATFORM
     end
 

src/spec/integration_support/sandbox.rb

@@ -15,6 +15,9 @@
 require 'integration_support/director_service'
 require 'integration_support/nginx_service'
 require 'integration_support/gnatsd_manager'
+require 'integration_support/bosh_agent'
+require 'integration_support/uaa_service'
+require 'integration_support/verify_multidigest_manager'
 
 module IntegrationSupport
   class Sandbox
@@ -73,6 +76,17 @@ def self.from_env
       )
     end
 
+    def self.install_dependencies
+      FileUtils.mkdir_p(IntegrationSupport::Constants::INTEGRATION_BIN_DIR)
+      IntegrationSupport::BoshAgent.install
+      IntegrationSupport::NginxService.install
+      IntegrationSupport::UaaService.install
+      IntegrationSupport::ConfigServerService.install
+      IntegrationSupport::VerifyMultidigestManager.install
+      IntegrationSupport::GnatsdManager.install
+    end
+
+
     def initialize(db_opts, debug, test_env_number)
       @debug = debug
       @name = SecureRandom.uuid.gsub('-', '')

src/spec/integration_support/uaa_service.rb

@@ -38,6 +38,8 @@ def initialize(sandbox_root, base_log_path)
     end
 
     def self.install
+      return if File.exist?(File.join(UAA_BIN_PATH, 'uaa'))
+
       %w{
         /var/vcap/sys/run/uaa
         /var/vcap/sys/log/uaa

src/spec/integration_support/verify_multidigest_manager.rb

@@ -1,3 +1,5 @@
+require 'integration_support/constants'
+
 module IntegrationSupport
   class VerifyMultidigestManager
     def self.install
@@ -16,19 +18,18 @@ def self.installer
   end
 
   class VerifyMultidigestBlobInstaller
-    INSTALL_DIR = File.join(IntegrationSupport::Constants::BOSH_REPO_SRC_DIR, 'tmp', 'integration-verify-multidigest')
-
     def install
+      return if File.exist?(executable_path)
+
       Dir.chdir(IntegrationSupport::Constants::BOSH_REPO_ROOT) do
-        run_command("mkdir -p #{INSTALL_DIR}")
         run_command('bosh sync-blobs')
         run_command("cp blobs/verify-multidigest/verify-multidigest-*-linux-amd64 #{executable_path}")
         run_command("chmod +x #{executable_path}")
       end
     end
 
     def executable_path
-      File.join(INSTALL_DIR, 'verify-multidigest')
+      File.join(IntegrationSupport::Constants::INTEGRATION_BIN_DIR, 'verify-multidigest')
     end
 
     private

src/tasks/spec.rake

@@ -5,41 +5,10 @@ require 'parallel_tests/tasks'
 namespace :spec do
   namespace :integration do
     require 'integration_support/workspace'
-    require 'integration_support/config_server_service'
-    require 'integration_support/nginx_service'
-    require 'integration_support/uaa_service'
-    require 'integration_support/verify_multidigest_manager'
-    require 'integration_support/gnatsd_manager'
-
-    desc 'Run health monitor integration tests against a local sandbox'
-    task health_monitor: :install_dependencies do
-      run_integration_specs(tags: 'hm')
-    end
-
-    desc 'Install BOSH integration test dependencies (currently Nginx, UAA, and Config Server)'
-    task :install_dependencies do
-      unless ENV['SKIP_DEPS'] == 'true'
-        IntegrationSupport::NginxService.install unless ENV['SKIP_NGINX'] == 'true'
-
-        IntegrationSupport::UaaService.install unless ENV['SKIP_UAA'] == 'true'
-
-        IntegrationSupport::ConfigServerService.install unless ENV['SKIP_CONFIG_SERVER'] == 'true'
-
-        IntegrationSupport::VerifyMultidigestManager.install unless ENV['SKIP_VERIFY_MULTIDIGEST'] == 'true'
-
-        IntegrationSupport::GnatsdManager.install unless ENV['SKIP_GNATSD'] == 'true'
-      end
-
-      compile_dependencies
-    end
-
-    desc 'Download BOSH Agent. Use only for local dev environment'
-    task :download_bosh_agent do
-      trap('INT') { exit }
-      sh('rm -rf bosh-agent && git clone https://github.com/cloudfoundry/bosh-agent.git')
-    end
+    require 'integration_support/sandbox'
 
     def run_integration_specs(tags: nil)
+      IntegrationSupport::Sandbox.install_dependencies
       IntegrationSupport::Workspace.clean
       IntegrationSupport::Workspace.uaa_service.start
 
@@ -63,15 +32,10 @@ namespace :spec do
     ensure
       IntegrationSupport::Workspace.uaa_service.stop
     end
-
-    def compile_dependencies
-      puts 'If this fails you may want to run rake spec:integration:download_bosh_agent'
-      sh('cd bosh-agent && bin/build && cd -')
-    end
   end
 
   desc 'Run all integration tests against a local sandbox'
-  task integration: %w[spec:integration:install_dependencies] do
+  task :integration do
     run_integration_specs
   end