Merge pull request #964 from alonweiss-sl/main

[Sealights Integration] Accept lab_id, proxy and enable_upgrade from user provisioned service

Author: pivotal-david-osullivan

docs/framework-sealights_agent.md

@@ -19,6 +19,10 @@ The credential payload can contain the following entries.
 | Name | Description
 | ---- | -----------
 | `token` | A Sealights Agent token
+| `proxy` | Specify a HTTP proxy used to communicate with the Sealights backend. Required when a corporate network prohibits communication to cloud services. The default is to have no proxy configured. This does not inherit from `http_proxy`/`https_proxy` or `http.proxyHost/https.proxyHost`, you must set this specifically if a proxy is needed.
+| `lab_id` | Specify a Sealights [Lab ID][]
+
+All fields above except the agent token may be also specified in the [Configuration Section](#configuration) below.
 
 ## Configuration
 For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to [Configuration and Extension][].
@@ -33,6 +37,8 @@ The framework can be configured by modifying the [`config/sealights_agent.yml`][
 | `auto_upgrade` | Enable/disable agent auto-upgrade. Off by default
 | `version` | The version of Auto-reconfiguration to use. Candidate versions can be found in [this listing][]. If auto_upgrade is turned on, a different version may be downloaded and used at runtime
 
+Configuration settings will take precedence over the ones specified in the [User-Provided Service](#user-provided-service), if those are defined.
+
 ## Troubleshooting and Support
 
 For additional documentation and support, visit the official [Sealights Java agents documentation] page

lib/java_buildpack/framework/sealights_agent.rb

@@ -43,10 +43,18 @@ def release
         credentials = @application.services.find_service(FILTER, TOKEN)['credentials']
         @droplet.java_opts.add_system_property('sl.token', Shellwords.escape(credentials[TOKEN]))
         @droplet.java_opts.add_system_property('sl.tags', 'pivotal_cloud_foundry')
-        add_system_property 'sl.enableUpgrade', ENABLE_UPGRADE
+
+        # add sl.enableUpgrade system property
+        @droplet.java_opts.add_system_property('sl.enableUpgrade', @configuration[ENABLE_UPGRADE] ? 'true' : 'false')
+
+        # add sl.proxy system property if defined (either in config or user provisioned service)
+        add_system_property_from_cfg_or_svc credentials, 'sl.proxy', PROXY
+
+        # add sl.labId system property if defined (either in config or user provisioned service)
+        add_system_property_from_cfg_or_svc credentials, 'sl.labId', LAB_ID
+
+        # add build session if defined in config
         add_system_property 'sl.buildSessionId', BUILD_SESSION_ID
-        add_system_property 'sl.proxy', PROXY
-        add_system_property 'sl.labId', LAB_ID
       end
 
       # wrapper for setting system properties on the droplet from configuration keys
@@ -56,6 +64,15 @@ def add_system_property(system_property, config_key)
         @droplet.java_opts.add_system_property(system_property, Shellwords.escape(@configuration[config_key]))
       end
 
+      # add a system property based on either plugin configuration (which takes precedence) or user provisioned service
+      def add_system_property_from_cfg_or_svc(svc, system_property, config_key)
+        if @configuration.key?(config_key)
+          @droplet.java_opts.add_system_property(system_property, Shellwords.escape(@configuration[config_key]))
+        elsif svc.key?(config_key)
+          @droplet.java_opts.add_system_property(system_property, Shellwords.escape(svc[config_key]))
+        end
+      end
+
       # (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)
       def supports?
         @application.services.one_service? FILTER, TOKEN

spec/java_buildpack/framework/sealights_agent_spec.rb

@@ -106,12 +106,49 @@
         expect(java_opts).not_to include(/proxy/)
       end
 
-      it 'does not specify JAVA_OPTS sl.enableUpgrade if one was not specified' do
+      it 'sets JAVA_OPTS sl.enableUpgrade to false by default' do
         component.release
 
-        expect(java_opts).not_to include(/enableUpgrade/)
+        expect(java_opts).to include('-Dsl.enableUpgrade=false')
       end
+    end
+
+    context do
+      let(:credentials) { { 'token' => 'my_token', 'proxy' => 'my_proxy', 'lab_id' => 'my_lab' } }
+      let(:configuration) { {} }
+
+      it 'updates JAVA_OPTS sl.labId from the user provisioned service' do
+        component.release
+
+        expect(java_opts).to include("-Dsl.labId=#{credentials['lab_id']}")
+      end
+
+      it 'updates JAVA_OPTS sl.proxy from the user provisioned service' do
+        component.release
+
+        expect(java_opts).to include("-Dsl.proxy=#{credentials['proxy']}")
+      end
+    end
 
+    context do
+      let(:credentials) { { 'token' => 'my_token', 'proxy' => 'my_proxy', 'lab_id' => 'my_lab' } }
+
+      let(:configuration) do
+        { 'proxy' => '127.0.0.1:8888',
+          'lab_id' => 'lab1' }
+      end
+
+      it 'updates JAVA_OPTS sl.labId from config (and not user provisioned service)' do
+        component.release
+
+        expect(java_opts).to include("-Dsl.labId=#{configuration['lab_id']}")
+      end
+
+      it 'updates JAVA_OPTS sl.proxy from config (and not user provisioned service)' do
+        component.release
+
+        expect(java_opts).to include("-Dsl.proxy=#{configuration['proxy']}")
+      end
     end
 
   end