Add project-run capabilities

Author: agranig

README.md

@@ -108,7 +108,14 @@ configuration.
 
 ### `project_id`
 
-**Required for `mode=project`** The id of the project to run.
+**Required for `mode=project`** (unless `project_name` is given) The id of the
+project to run. Takes precedence over `project_name` if both are set.
+
+### `project_name`
+
+**Optional (`mode=project`)** The name of the project to run, used when
+`project_id` is not set. Either `project_id` or `project_name` is required for
+`mode=project`.
 
 ### `test_ids`
 

__tests__/main.test.js

@@ -180,6 +180,7 @@ describe('action', () => {
         'key',
         'secret',
         '42',
+        '',
         [1, 2, 3],
         '',
         'dev',
@@ -188,6 +189,42 @@ describe('action', () => {
       )
     })
 
+    it('runs a project by name when no id is given', async () => {
+      getInputMock.mockImplementation(name => {
+        if (name === 'project_id') return ''
+        if (name === 'project_name') return 'my-project'
+        return projectInputs[name] ?? ''
+      })
+      runProjectMock.mockResolvedValue(passedProjectRun)
+
+      await main.run()
+      expect(runProjectMock).toHaveBeenCalledWith(
+        'key',
+        'secret',
+        '',
+        'my-project',
+        [],
+        '',
+        'dev',
+        3,
+        1800
+      )
+      expect(setFailedMock).not.toHaveBeenCalled()
+    })
+
+    it('fails when neither project_id nor project_name is given', async () => {
+      getInputMock.mockImplementation(name => {
+        if (name === 'project_id') return ''
+        return projectInputs[name] ?? ''
+      })
+
+      await main.run()
+      expect(setFailedMock).toHaveBeenCalledWith(
+        "mode=project requires 'project_id' or 'project_name'"
+      )
+      expect(runProjectMock).not.toHaveBeenCalled()
+    })
+
     it('fails the run when the project run failed', async () => {
       runProjectMock.mockResolvedValue({
         ...passedProjectRun,

action.yml

@@ -24,7 +24,10 @@ inputs:
     description: 'The destination to call, overriding the test configuration (mode=test)'
     required: false
   project_id:
-    description: 'The id of the project to run (required when mode=project)'
+    description: 'The id of the project to run (mode=project; takes precedence over project_name)'
+    required: false
+  project_name:
+    description: 'The name of the project to run (mode=project; used when project_id is not set)'
     required: false
   test_ids:
     description: 'Comma-separated subset of test ids to run (mode=project, optional)'

badges/coverage.svg

@@ -96,10 +96,15 @@ async function run_test_mode(common) {
  * @returns {Promise<void>} Resolves once outputs are set.
  */
 async function run_project_mode(common) {
-  const project_id = core.getInput('project_id', { required: true })
+  const project_id = core.getInput('project_id', { required: false })
+  const project_name = core.getInput('project_name', { required: false })
   const test_ids = id_list_input('test_ids')
 
-  let msg = `Running project '${project_id}'`
+  if (!project_id && !project_name) {
+    throw new Error("mode=project requires 'project_id' or 'project_name'")
+  }
+
+  let msg = `Running project '${project_id || project_name}'`
   if (test_ids.length) {
     msg += ` (tests ${test_ids.join(',')})`
   }
@@ -112,6 +117,7 @@ async function run_project_mode(common) {
     common.public_key,
     common.secret_key,
     project_id,
+    project_name,
     test_ids,
     common.report_mode,
     common.sf_environment,

dist/index.js

@@ -188,7 +188,8 @@ async function run_call_test(
  *
  * @param {string} public_key The public API key for the Sipfront API.
  * @param {string} secret_key The secret API key for the Sipfront API.
- * @param {string} project_id The id of the project to run.
+ * @param {string} project_id The id of the project to run (takes precedence).
+ * @param {string} project_name The name of the project to run (used if no id).
  * @param {number[]} test_ids Optional subset of test ids to run.
  * @param {string} report_mode Optional report mode ('full' or 'kiosk').
  * @param {string} sf_environment Internal environment selector for testing.
@@ -201,6 +202,7 @@ async function run_project(
   public_key,
   secret_key,
   project_id,
+  project_name,
   test_ids,
   report_mode,
   sf_environment,
@@ -210,8 +212,12 @@ async function run_project(
   const api_base = api_base_for(sf_environment)
   const httpc = make_client(public_key, secret_key)
 
-  const data = {
-    id: Number(project_id)
+  // The API gives `id` precedence over `project.name` when both are present.
+  const data = {}
+  if (project_id && String(project_id).length > 0) {
+    data.id = Number(project_id)
+  } else if (project_name && project_name.length > 0) {
+    data['project.name'] = project_name
   }
   if (report_mode && report_mode.length > 0) {
     data['report.mode'] = report_mode