chore: add workload name for skope warn logging

We don't have much context for where the failed pulling image is coming from in the warning log
in Skopeo pull. By adding the workload name, we hope to get some association to see where the image
is coming from.

Author: minsiyang

src/scanner/images/index.ts

@@ -23,27 +23,30 @@ const statAsync = promisify(stat);
 */
 async function pullImageBySkopeoRepo(
   imageToPull: IPullableImage,
+  workloadName: string,
 ): Promise<IPullableImage> {
   // Scan image by digest if exists, other way fallback tag
   const scanId = imageToPull.imageWithDigest ?? imageToPull.imageName;
   await skopeoCopy(
     scanId,
     imageToPull.fileSystemPath,
     imageToPull.skopeoRepoType,
+    workloadName,
   );
   return imageToPull;
 }
 
 export async function pullImages(
   images: IPullableImage[],
+  workloadName: string,
 ): Promise<IPullableImage[]> {
   const pulledImages: IPullableImage[] = [];
   for (const image of images) {
     if (!image.fileSystemPath) {
       continue;
     }
     try {
-      const pulledImage = await pullImageBySkopeoRepo(image);
+      const pulledImage = await pullImageBySkopeoRepo(image, workloadName);
       pulledImages.push(pulledImage);
     } catch (error) {
       logger.error(

src/scanner/images/skopeo.ts

@@ -36,6 +36,7 @@ export async function pull(
   image: string,
   destination: string,
   skopeoRepoType: SkopeoRepositoryType,
+  workloadName: string,
 ): Promise<void> {
   const creds = await credentials.getSourceCredentials(image);
   const credentialsParameters = getCredentialParameters(creds);
@@ -56,12 +57,13 @@ export async function pull(
     sanitise: false,
   });
 
-  await pullWithRetry(args, destination);
+  await pullWithRetry(args, destination, workloadName);
 }
 
 async function pullWithRetry(
   args: Array<processWrapper.IProcessArgument>,
   destination: string,
+  workloadName: string,
 ): Promise<void> {
   const MAX_ATTEMPTS = 10;
   const RETRY_INTERVAL_SEC = 0.2;
@@ -77,7 +79,7 @@ async function pullWithRetry(
         }
       } catch (deleteErr) {
         logger.warn(
-          { error: deleteErr, destination },
+          { workloadName, error: deleteErr, destination },
           'could not clean up the Skopeo-copy archive',
         );
       }

src/scanner/index.ts

@@ -41,7 +41,7 @@ export async function processWorkload(
   );
   const imagesWithFileSystemPath = getImagesWithFileSystemPath(uniqueImages);
   const imagePullStartTimestampMs = Date.now();
-  const pulledImages = await pullImages(imagesWithFileSystemPath);
+  const pulledImages = await pullImages(imagesWithFileSystemPath, workloadName);
   const imagePullDurationMs = Date.now() - imagePullStartTimestampMs;
   if (pulledImages.length === 0) {
     logger.info(

test/unit/scanner/images.spec.ts

@@ -58,7 +58,11 @@ describe('getImagesWithFileSystemPath()', () => {
 describe('pullImages()', () => {
   it('skips on missing file system path', async () => {
     const badImage = [{ imageName: 'nginx:latest' }];
-    const result = await scannerImages.pullImages(badImage as IPullableImage[]);
+    const workloadName = 'workload';
+    const result = await scannerImages.pullImages(
+      badImage as IPullableImage[],
+      workloadName,
+    );
     expect(result).toEqual([]);
   });
 });