HARMONY-2030: Make successful service deployment logs available via Harmony deployment logs endpoint.

Author: ygliuvt

services/harmony/app/frontends/service-image-tags.ts

@@ -436,12 +436,12 @@ export async function getServiceImageTag(
 }
 
 /**
- *  Get the log location of service deployment errors
+ *  Get the log location of service deployment
  *
  * @param deploymentId - The id of service deployment
  */
 function getLogLocation(deploymentId: string ): string {
-  return `s3://${env.artifactBucket}/${deploymentId}/errors.json`;
+  return `s3://${env.artifactBucket}/${deploymentId}/log.json`;
 }
 
 /**
@@ -450,8 +450,8 @@ function getLogLocation(deploymentId: string ): string {
  * @param req - The request object
  * @param service  - The name of the service to deploy
  * @param tag  - The service image tag to deploy
- * @param regressionTestVersion  - The regression test version to run the regression test with
  * @param deploymentId  - The deployment id
+ * @param regressionTestVersion  - The regression test version to run the regression test with
  */
 export async function execDeployScript(
   req: HarmonyRequest,
@@ -473,17 +473,15 @@ export async function execDeployScript(
 
   exec(command, options, async (error, stdout, _stderr) => {
     const lines = stdout.split('\n');
+    // save the service deployment log to S3
+    const s3 = objectStoreForProtocol('s3');
+    const logLocation = getLogLocation(deploymentId);
+    await s3.upload(JSON.stringify(lines), logLocation);
+
+    const urlRoot = getRequestRoot(req);
+    const logUrl = `${urlRoot}/deployment-logs/${deploymentId}`;
     if (error) {
       req.context.logger.error(`Error executing script: ${error.message}`);
-
-      // save the service deployment errors to S3
-      const logLocation = getLogLocation(deploymentId);
-      const s3 = objectStoreForProtocol('s3');
-      await s3.upload(JSON.stringify(lines), logLocation);
-
-      const urlRoot = getRequestRoot(req);
-      const logUrl = `${urlRoot}/deployment-logs/${deploymentId}`;
-
       lines.forEach(line => {
         req.context.logger.info(`Failed script output: ${line}`);
       });
@@ -500,7 +498,10 @@ export async function execDeployScript(
       // only re-enable the service deployment on successful deployment
       await enableServiceDeployment(`Re-enable service deployment after successful deployment: ${deploymentId}`);
       await db.transaction(async (tx) => {
-        await setStatusMessage(tx, deploymentId, 'successful', 'Deployment successful');
+        await setStatusMessage(tx,
+          deploymentId,
+          'successful',
+          `Deployment successful. See details at: ${logUrl}`);
       });
     }
   });

services/harmony/test/service-image-tags.ts

@@ -1153,7 +1153,7 @@ describe('Service image endpoint', async function () {
                 expect(service).to.eql('harmony-service-example');
                 expect(tag).to.eql('foo');
                 expect(status).to.eql('successful');
-                expect(message).to.eql('Deployment successful');
+                expect(message).to.include('Deployment successful');
               });
             });
 
@@ -1178,7 +1178,7 @@ describe('Service image endpoint', async function () {
                 expect(service).to.eql('harmony-service-example');
                 expect(tag).to.eql('foo');
                 expect(status).to.eql('successful');
-                expect(message).to.eql('Deployment successful');
+                expect(message).to.include('Deployment successful');
               });
             });
           });
@@ -1196,6 +1196,7 @@ describe('Service self-deployment successful', async function () {
     let execDeployScriptStub: sinon.SinonStub;
     let link = null;
     let linkDeploymentId = null;
+    let deploymentLogPath = null;
 
     hookDescribeImage({
       imageDigest: '',
@@ -1258,14 +1259,53 @@ describe('Service self-deployment successful', async function () {
 
       it('returns the deployment status successful', async function () {
         const { deploymentId, username, service, tag, regressionTestVersion, status, message } = this.res.body;
+        deploymentLogPath = `/deployment-logs/${deploymentId}`;
         expect(deploymentId).to.eql(linkDeploymentId);
         expect(username).to.eql('buzz');
         expect(service).to.eql('harmony-service-example');
         expect(tag).to.eql('foo');
         // regressionTestVersion is set to the default value
         expect(regressionTestVersion).to.eql('latest');
         expect(status).to.eql('successful');
-        expect(message).to.eql('Deployment successful');
+        expect(message).to.include('Deployment successful');
+        expect(message).to.include(`See details at: http://127.0.0.1:4000${deploymentLogPath}`);
+      });
+    });
+
+    describe('when get the service deployment log with authorized user', async function () {
+      before(async function () {
+        hookRedirect('coraline');
+        this.res = await request(this.frontend).get(deploymentLogPath).use(auth({ username: 'coraline' }));
+      });
+
+      after(function () {
+        delete this.res;
+      });
+
+      it('returns a status 200', async function () {
+        expect(this.res.status).to.equal(200);
+      });
+
+      it('returns enabled false', async function () {
+        expect(this.res.body).to.eql(['Success output']);
+      });
+    });
+
+    describe('when get the service deployment log with unauthorized user', async function () {
+      before(async function () {
+        hookRedirect('coraline');
+        this.res = await request(this.frontend).get(deploymentLogPath).use(auth({ username: 'joe' }));
+      });
+
+      after(function () {
+        delete this.res;
+      });
+
+      it('returns a status 403', async function () {
+        expect(this.res.status).to.equal(403);
+      });
+      it('returns a meaningful error message', async function () {
+        expect(this.res.text).to.equal('User joe does not have permission to access this resource');
       });
     });