Log input choice

Author: mbg

lib/entry-points.js

@@ -2,15 +2,20 @@ import test from "ava";
 import sinon from "sinon";
 
 import { RepositoryPropertyName } from "../feature-flags/properties";
-import { getTestActionsEnv, setupTests } from "../testing-utils";
+import {
+  getTestActionsEnv,
+  RecordingLogger,
+  setupTests,
+} from "../testing-utils";
 
 import { getConfigFileInput } from "./file";
 
 setupTests(test);
 
 test("getConfigFileInput returns undefined by default", async (t) => {
+  const logger = new RecordingLogger();
   const actionsEnv = getTestActionsEnv();
-  const result = getConfigFileInput(actionsEnv, {});
+  const result = getConfigFileInput(logger, actionsEnv, {});
   t.is(result, undefined);
 });
 
@@ -19,6 +24,7 @@ const repositoryProperties = {
 };
 
 test("getConfigFileInput returns input value", async (t) => {
+  const logger = new RecordingLogger();
   const actionsEnv = getTestActionsEnv();
   const testInput = "/some/path";
   sinon
@@ -28,14 +34,25 @@ test("getConfigFileInput returns input value", async (t) => {
 
   // Even though both an input and repository property are configured,
   // we prefer the direct input to the Action.
-  const result = getConfigFileInput(actionsEnv, repositoryProperties);
+  const result = getConfigFileInput(logger, actionsEnv, repositoryProperties);
   t.is(result, testInput);
+
+  // Check for the expected log message.
+  t.true(logger.hasMessage("Using configuration file input from workflow"));
 });
 
 test("getConfigFileInput returns repository property value", async (t) => {
+  const logger = new RecordingLogger();
   const actionsEnv = getTestActionsEnv();
 
   // Since there is no direct input, we should use the repository property.
-  const result = getConfigFileInput(actionsEnv, repositoryProperties);
+  const result = getConfigFileInput(logger, actionsEnv, repositoryProperties);
   t.is(result, repositoryProperties[RepositoryPropertyName.CONFIG_FILE]);
+
+  // Check for the expected log message.
+  t.true(
+    logger.hasMessage(
+      "Using configuration file input from repository property",
+    ),
+  );
 });

src/config/file.test.ts

@@ -3,16 +3,32 @@ import {
   RepositoryProperties,
   RepositoryPropertyName,
 } from "../feature-flags/properties";
+import { Logger } from "../logging";
 
 /**
  * Gets the value that is configured for the configuration file, if any.
  */
 export function getConfigFileInput(
+  logger: Logger,
   actions: ActionsEnv,
   repositoryProperties: Partial<RepositoryProperties>,
 ): string | undefined {
-  return (
-    actions.getOptionalInput("config-file") ||
-    repositoryProperties[RepositoryPropertyName.CONFIG_FILE]
-  );
+  const input = actions.getOptionalInput("config-file");
+
+  if (input !== undefined) {
+    logger.info(`Using configuration file input from workflow: ${input}`);
+    return input;
+  }
+
+  const propertyValue =
+    repositoryProperties[RepositoryPropertyName.CONFIG_FILE];
+
+  if (propertyValue !== undefined) {
+    logger.info(
+      `Using configuration file input from repository property: ${propertyValue}`,
+    );
+    return propertyValue;
+  }
+
+  return undefined;
 }

src/config/file.ts

@@ -263,7 +263,7 @@ async function run(startedAt: Date) {
 
     core.exportVariable(EnvVar.INIT_ACTION_HAS_RUN, "true");
 
-    configFile = getConfigFileInput(actionsEnv, repositoryProperties);
+    configFile = getConfigFileInput(logger, actionsEnv, repositoryProperties);
 
     // path.resolve() respects the intended semantics of source-root. If
     // source-root is relative, it is relative to the GITHUB_WORKSPACE. If