update image source on build

- including in-place upgrade from package-blobstore to package-registry

[#173343000]

Co-authored-by: Connor Braa <cbraa@pivotal.io>
Co-authored-by: Piyali Banerjee <pbanerjee@pivotal.io>

Author: cwlbraa

lib/cloud_controller/kpack/stager.rb

@@ -57,7 +57,7 @@ def mark_build_as_failed(build, message)
     def update_image_resource(image, staging_details, builder_spec)
       image.metadata.labels[DROPLET_GUID_LABEL_KEY.to_sym] = create_droplet_and_get_guid(staging_details)
       image.metadata.labels[BUILD_GUID_LABEL_KEY.to_sym] = staging_details.staging_guid
-      image.spec.source.blob.url = blobstore_url_generator.package_download_url(staging_details.package)
+      image.spec.source = get_source(staging_details)
       image.spec.build.env = get_environment_variables(staging_details)
       image.spec.builder = builder_spec
 
@@ -83,23 +83,21 @@ def image_resource(staging_details, builder_spec)
           serviceAccount: registry_service_account_name,
           builder: builder_spec,
           tag: "#{registry_tag_base}/#{staging_details.package.app.guid}",
-          source: configure_source(staging_details),
+          source: get_source(staging_details),
           build: {
             env: get_environment_variables(staging_details),
           }
         }
       })
     end
 
-    def configure_source(staging_details)
-      if registry_configured?
-        package_registry_base_path = config.get(:packages, :image_registry, :base_path)
-        { registry: {
+    def get_source(staging_details)
+      package_registry_base_path = config.get(:packages, :image_registry, :base_path)
+      {
+        registry: {
           image: "#{package_registry_base_path}/#{staging_details.package.guid}@sha256:#{staging_details.package.sha256_checksum}"
-        } }
-      else
-        { blob: { url: blobstore_url_generator.package_download_url(staging_details.package) } }
-      end
+        }
+      }
     end
 
     def get_environment_variables(staging_details)

lib/kubernetes/api_client.rb

@@ -14,7 +14,7 @@ def initialize(build_kube_client:, kpack_kube_client:, route_kube_client:)
     def create_image(resource_config)
       @build_kube_client.create_image(resource_config)
     rescue Kubeclient::HttpError => e
-      logger.error('create_image', error: e.inspect, response: e.response, backtrace: e.backtrace)
+      logger.error('create_image', error: e.inspect, response: e.response, backtrace: e.backtrace, resource: resource_config)
       raise CloudController::Errors::ApiError.new_from_details('KpackImageError', 'create', e.message)
     end
 

lib/package_image_uploader/client.rb

@@ -1,3 +1,5 @@
+require 'jsonclient'
+
 module PackageImageUploader
   class Client
     def initialize(host, port)
@@ -7,15 +9,18 @@ def initialize(host, port)
     def post_package(package_guid, zip_file_path, registry)
       response = with_request_error_handling do
         client.post('/packages',
-        { package_zip_path: zip_file_path, package_guid: package_guid, registry_base_path: registry })
+          body: { 'package_zip_path' => zip_file_path,
+            'package_guid' => package_guid,
+            'registry_base_path' => registry }
+        )
       end
       JSON.parse(response.body)
     end
 
     private
 
     def client
-      HTTPClient.new(base_url: @url)
+      @client ||= JSONClient.new(base_url: @url)
     end
 
     def logger

spec/unit/lib/cloud_controller/kpack/stager_spec.rb

@@ -60,7 +60,9 @@ module Kpack
         }
       )
     }
+
     before do
+      TestConfig.override({ packages: { image_registry: { base_path: 'hub.example.com/user' } } })
       allow(CloudController::DependencyLocator.instance).to receive(:k8s_api_client).and_return(client)
       allow(CloudController::DependencyLocator.instance).to receive(:blobstore_url_generator).and_return(blobstore_url_generator)
       allow(client).to receive(:get_image).and_return(nil)
@@ -102,95 +104,45 @@ module Kpack
         stager.stage(staging_details)
       end
 
-      context 'package image registry is configured' do
-        before do
-          TestConfig.override({ packages: { image_registry: { base_path: 'hub.example.com/user' } } })
-        end
-
-        it 'creates an image with an image path from a registry for the source code using the kpack client' do
-          expect(client).to_not receive(:update_image)
-          expect(client).to_not receive(:create_custom_builder)
-          expect(client).to receive(:create_image).with(Kubeclient::Resource.new({
-            metadata: {
-              name: package.app.guid,
-              namespace: 'namespace',
-              labels: {
-                Stager::DROPLET_GUID_LABEL_KEY => droplet.guid,
-                Stager::APP_GUID_LABEL_KEY => package.app.guid,
-                Stager::BUILD_GUID_LABEL_KEY => build.guid,
-                Stager::STAGING_SOURCE_LABEL_KEY => 'STG',
-              },
-              annotations: {
-                'sidecar.istio.io/inject' => 'false'
-              }
+      it 'creates an image with an image path from a registry for the source code using the kpack client' do
+        expect(client).to_not receive(:update_image)
+        expect(client).to_not receive(:create_custom_builder)
+        expect(client).to receive(:create_image).with(Kubeclient::Resource.new({
+          metadata: {
+            name: package.app.guid,
+            namespace: 'namespace',
+            labels: {
+              Stager::DROPLET_GUID_LABEL_KEY => droplet.guid,
+              Stager::APP_GUID_LABEL_KEY => package.app.guid,
+              Stager::BUILD_GUID_LABEL_KEY => build.guid,
+              Stager::STAGING_SOURCE_LABEL_KEY => 'STG',
             },
-            spec: {
-              tag: "gcr.io/capi-images/#{package.app.guid}",
-              serviceAccount: 'gcr-service-account',
-              builder: {
-                name: 'cf-default-builder',
-                kind: 'CustomBuilder'
-              },
-              source: {
-                registry: {
-                  image: "hub.example.com/user/#{package.guid}@sha256:#{package.sha256_checksum}",
-                }
-              },
-              build: {
-                env: [
-                  { name: 'BP_JAVA_VERSION', value: '8.*' },
-                  { name: 'BPL_HEAD_ROOM', value: '0' },
-                ]
-              }
+            annotations: {
+              'sidecar.istio.io/inject' => 'false'
             }
-          }))
-
-          stager.stage(staging_details)
-        end
-      end
-
-      context 'package image registry is not configured' do
-        it 'creates an image with a blobstore url for the source code using the kpack client' do
-          expect(client).to_not receive(:update_image)
-          expect(client).to_not receive(:create_custom_builder)
-          expect(client).to receive(:create_image).with(Kubeclient::Resource.new({
-            metadata: {
-              name: package.app.guid,
-              namespace: 'namespace',
-              labels: {
-                Stager::DROPLET_GUID_LABEL_KEY => droplet.guid,
-                Stager::APP_GUID_LABEL_KEY => package.app.guid,
-                Stager::BUILD_GUID_LABEL_KEY => build.guid,
-                Stager::STAGING_SOURCE_LABEL_KEY => 'STG',
-              },
-              annotations: {
-                'sidecar.istio.io/inject' => 'false'
-              }
+          },
+          spec: {
+            tag: "gcr.io/capi-images/#{package.app.guid}",
+            serviceAccount: 'gcr-service-account',
+            builder: {
+              name: 'cf-default-builder',
+              kind: 'CustomBuilder'
             },
-            spec: {
-              tag: "gcr.io/capi-images/#{package.app.guid}",
-              serviceAccount: 'gcr-service-account',
-              builder: {
-                name: 'cf-default-builder',
-                kind: 'CustomBuilder'
-              },
-              source: {
-                blob: {
-                  url: 'package-download-url',
-                }
-              },
-              build: {
-                env: [
-                  { name: 'BP_JAVA_VERSION', value: '8.*' },
-                  { name: 'BPL_HEAD_ROOM', value: '0' },
-                ]
+            source: {
+              registry: {
+                image: "hub.example.com/user/#{package.guid}@sha256:#{package.sha256_checksum}",
               }
+            },
+            build: {
+              env: [
+                { name: 'BP_JAVA_VERSION', value: '8.*' },
+                { name: 'BPL_HEAD_ROOM', value: '0' },
+              ]
             }
-          }))
+          }
+        }))
 
-          stager.stage(staging_details)
-          expect(blobstore_url_generator).to have_received(:package_download_url).with(package)
-        end
+        stager.stage(staging_details)
       end
 
       context 'when specifying buildpacks for a build' do
@@ -323,7 +275,7 @@ module Kpack
                 name: 'cf-autodetect-builder', # legacy Builder to verify that image update includes new CustomBuilder
                 kind: 'Builder'
               },
-              source: {
+              source: { # here we test that blob sources can be upgraded to registry sources in-place
                 blob: {
                   url: 'old-package-url',
                 }
@@ -347,7 +299,11 @@ module Kpack
           updated_image = Kubeclient::Resource.new(existing_image.to_hash)
           updated_image.metadata.labels[Kpack::Stager::BUILD_GUID_LABEL_KEY.to_sym] = build.guid
           updated_image.metadata.labels[Kpack::Stager::DROPLET_GUID_LABEL_KEY.to_sym] = droplet.guid
-          updated_image.spec.source.blob.url = 'package-download-url'
+          updated_image.spec.source = {
+            registry: {
+              image: "hub.example.com/user/#{package.guid}@sha256:#{package.sha256_checksum}",
+            }
+          }
           updated_image.spec.build.env = [
             { name: 'FOO', value: 'BAR' }
           ]