[ISSUE 199] Log commit hash while describing checkout/merge

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# V2.6.2
+
+## Enhancements:
+
+- Prints out the hashes during check out/merging process
+
 # V2.6.1
 
 ## Enhancements:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kie/build-chain-action",
-  "version": "2.3.25",
+  "version": "2.3.26",
   "description": "Library to execute commands based on github projects dependencies.",
   "main": "dist/build-chain-cli.js",
   "author": "Enrique Mingorance Cano <[email protected]>",

src/lib/flows/common/build-chain-flow-helper.js

@@ -7,6 +7,7 @@ const {
   getForkedProject,
   getRepository
 } = require("../../git");
+const { getRemoteSha } = require("../../service/git-service");
 const { logger } = require("../../common");
 const { treatUrl } = require("@kie/build-chain-configuration-reader");
 const { checkUrlExist } = require("../../util/http");
@@ -205,9 +206,19 @@ async function checkoutProjectPullRequestFlow(
  * @param {Object} dir the dir to check out
  */
 async function checkoutNode(context, node, checkoutInfo, dir) {
+  const sourceHash = await getRemoteSha(
+    `${context.config.github.serverUrl}/${checkoutInfo.group}/${checkoutInfo.project}`,
+    checkoutInfo.branch
+  );
+
   if (checkoutInfo.merge) {
+    const targetHash = await getRemoteSha(
+      `${context.config.github.serverUrl}/${node.project}`,
+      checkoutInfo.targetBranch
+    );
+
     logger.info(
-      `[${node.project}] Merging ${context.config.github.serverUrl}/${node.project}:${checkoutInfo.targetBranch} into ${context.config.github.serverUrl}/${checkoutInfo.group}/${checkoutInfo.project}:${checkoutInfo.branch}`
+      `[${node.project}] Checking out ${context.config.github.serverUrl}/${node.project}:${checkoutInfo.targetBranch} ${targetHash} and merging ${context.config.github.serverUrl}/${checkoutInfo.group}/${checkoutInfo.project}:${checkoutInfo.branch} ${sourceHash} into '${dir}'`
     );
     try {
       await clone(
@@ -244,7 +255,7 @@ async function checkoutNode(context, node, checkoutInfo, dir) {
   } else {
     try {
       logger.info(
-        `[${node.project}] Checking out '${context.config.github.serverUrl}/${checkoutInfo.group}/${checkoutInfo.project}:${checkoutInfo.branch}' into '${dir}'`
+        `[${node.project}] Checking out '${context.config.github.serverUrl}/${checkoutInfo.group}/${checkoutInfo.project}:${checkoutInfo.branch}' ${sourceHash} into '${dir}'`
       );
       await clone(
         `${context.config.github.serverUrlWithToken}/${checkoutInfo.group}/${checkoutInfo.project}`,

src/lib/git.js

@@ -174,6 +174,16 @@ async function sha(dir, branch) {
   return await git(dir, "show-ref", "-s", `refs/remotes/origin/${branch}`);
 }
 
+/**
+ * It retrieves the hash from a remote repository and branch
+ *
+ * @param {string} repositoryUrl the repository URL
+ * @param {string} branch the branch to get the hash from
+ */
+async function remoteSha(repositoryUrl, branch) {
+  return await git(".", "ls-remote", repositoryUrl, branch);
+}
+
 async function rename(dir, branch) {
   return await git(dir, "branch", "--move", branch);
 }
@@ -363,6 +373,7 @@ module.exports = {
   merge,
   head,
   sha,
+  remoteSha,
   rename,
   rebase,
   push,

src/lib/service/git-service.js

@@ -0,0 +1,24 @@
+const git = require("../git");
+const { logger } = require("../common");
+
+/**
+ * It treats a git hash from a remote repositry.
+ *
+ * @param {string} repositoryUrl the repository URL
+ * @param {string} branch the branch to get the hash from
+ * @param {number} hashLength the length of hash to return back
+ */
+async function getRemoteSha(repositoryUrl, branch, hashLength = 7) {
+  try {
+    const remoteHashValue = await git.remoteSha(repositoryUrl, branch);
+    logger.debug(`Hash for ${repositoryUrl}:${branch} '${remoteHashValue}'`);
+    return `@${remoteHashValue.substring(0, hashLength)}`;
+  } catch (e) {
+    logger.warn(
+      `Error getting sha for ${repositoryUrl}:${branch}. It is only for logging purposes, no worries.`
+    );
+    return undefined;
+  }
+}
+
+module.exports = { getRemoteSha };

test/git.test.js

@@ -150,3 +150,36 @@ describe("version", () => {
     ]);
   });
 });
+
+describe("remoteSha", () => {
+  test("ok", async () => {
+    // Arrange
+    const repositoryUrl = "https://repositoryUrl";
+    const branch = "branchName";
+    spawnMock.sequence.add(
+      spawnMock.simple(
+        0,
+        "9a7f82f4b090a37a855aa582d2160951853a9141        refs/heads/main"
+      )
+    );
+    // Act
+    const result = await git.remoteSha(repositoryUrl, branch);
+
+    // Assert
+    expect(spawnMock.calls.length).toBe(1);
+    const firstCall = spawnMock.calls[0];
+    expect(firstCall.command).toBe("git");
+    expect(firstCall.args).toStrictEqual([
+      "-c",
+      "user.name=GitHub",
+      "-c",
+      "[email protected]",
+      "ls-remote",
+      repositoryUrl,
+      branch
+    ]);
+    expect(result).toBe(
+      "9a7f82f4b090a37a855aa582d2160951853a9141        refs/heads/main"
+    );
+  });
+});

test/lib/flows/common/build-chain-flow-helper.test.js

@@ -27,6 +27,9 @@ const { checkUrlExist } = require("../../../../src/lib/util/http");
 jest.mock("../../../../src/lib/util/http");
 jest.mock("../../../../src/lib/common");
 
+const { getRemoteSha } = require("../../../../src/lib/service/git-service");
+jest.mock("../../../../src/lib/service/git-service");
+
 afterEach(() => {
   jest.clearAllMocks();
 });
@@ -434,6 +437,24 @@ describe("checkoutDefinitionTree", () => {
     // Act
     const result = await checkoutDefinitionTree(context, nodeChain);
     // Assert
+    expect(getRemoteSha).toHaveBeenCalledTimes(4);
+    expect(getRemoteSha).toHaveBeenCalledWith(
+      "URL/sourceGroup/lienzo-core-forked",
+      "sBranch"
+    );
+    expect(getRemoteSha).toHaveBeenCalledWith(
+      "URL/kiegroup/lienzo-core",
+      "tBranch"
+    );
+    expect(getRemoteSha).toHaveBeenCalledWith(
+      "URL/sourceGroup/droolsjbpm-build-bootstrap-forked",
+      "sBranch"
+    );
+    expect(getRemoteSha).toHaveBeenCalledWith(
+      "URL/kiegroup/droolsjbpm-build-bootstrap",
+      "tBranch"
+    );
+
     expect(mergeMock).toHaveBeenCalledTimes(2);
     expect(mergeMock).toHaveBeenCalledWith(
       "folder/kiegroup_lienzo_core",
@@ -543,6 +564,20 @@ describe("checkoutDefinitionTree", () => {
     const result = await checkoutDefinitionTree(context, nodeChain);
 
     // Assert
+    expect(getRemoteSha).toHaveBeenCalledTimes(3);
+    expect(getRemoteSha).toHaveBeenCalledWith(
+      "URL/sourceGroup/lienzo-core-forked",
+      "sBranch"
+    );
+    expect(getRemoteSha).toHaveBeenCalledWith(
+      "URL/kiegroup/lienzo-core",
+      "tBranch"
+    );
+    expect(getRemoteSha).toHaveBeenCalledWith(
+      "URL/kiegroup/droolsjbpm-build-bootstrap",
+      "tBranch"
+    );
+
     expect(mergeMock).toHaveBeenCalledTimes(1);
     expect(mergeMock).toHaveBeenCalledWith(
       "folder/kiegroup_lienzo_core",

test/lib/service/git-service.test.js

@@ -0,0 +1,59 @@
+const { getRemoteSha } = require("../../../src/lib/service/git-service");
+const { remoteSha } = require("../../../src/lib/git");
+jest.mock("../../../src/lib/git");
+jest.mock("../../../src/lib/common");
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+describe("getRemoteSha", () => {
+  test("ok", async () => {
+    // Arrange
+    const repositoryUrl = "https://repositoryUrl";
+    const branch = "branchName";
+    remoteSha.mockResolvedValueOnce(
+      "9a7f82f4b090a37a855aa582d2160951853a9141        refs/heads/main"
+    );
+
+    // Act
+    const result = await getRemoteSha(repositoryUrl, branch);
+
+    // Assert
+    expect(remoteSha).toHaveBeenCalledTimes(1);
+    expect(remoteSha).toHaveBeenCalledWith(repositoryUrl, branch);
+    expect(result).toBe("@9a7f82f");
+  });
+
+  test("ok different length", async () => {
+    // Arrange
+    const repositoryUrl = "https://repositoryUrlX";
+    const branch = "branchNameX";
+    remoteSha.mockResolvedValueOnce(
+      "9a7f82f4b090a37a855aa582d2160951853a9141        refs/heads/main"
+    );
+
+    // Act
+    const result = await getRemoteSha(repositoryUrl, branch, 10);
+
+    // Assert
+    expect(remoteSha).toHaveBeenCalledTimes(1);
+    expect(remoteSha).toHaveBeenCalledWith(repositoryUrl, branch);
+    expect(result).toBe("@9a7f82f4b0");
+  });
+
+  test("not existing", async () => {
+    // Arrange
+    const repositoryUrl = "https://repositoryUrlY";
+    const branch = "branchNameY";
+    remoteSha.mockResolvedValueOnce(undefined);
+
+    // Act
+    const result = await getRemoteSha(repositoryUrl, branch);
+
+    // Assert
+    expect(remoteSha).toHaveBeenCalledTimes(1);
+    expect(remoteSha).toHaveBeenCalledWith(repositoryUrl, branch);
+    expect(result).toBe(undefined);
+  });
+});