51735c415b
Closes #2797 I'm aware of https://github.com/go-gitea/gitea/pull/28163 exists, but since I had it laying around on my drive and collecting dust, I might as well open a PR for it if anyone wants the feature a bit sooner than waiting for upstream to release it or to be a forgejo "native" implementation. This PR Contains: - Support for the `workflow_dispatch` trigger - Inputs: boolean, string, number, choice Things still to be done: - [x] API Endpoint `/api/v1/<org>/<repo>/actions/workflows/<workflow id>/dispatches` - ~~Fixing some UI bugs I had no time figuring out, like why dropdown/choice inputs's menu's behave weirdly~~ Unrelated visual bug with dropdowns inside dropdowns - [x] Fix bug where opening the branch selection submits the form - [x] Limit on inputs to render/process Things not in this PR: - Inputs: environment (First need support for environments in forgejo) Things needed to test this: - A patch for https://code.forgejo.org/forgejo/runner to actually consider the inputs inside the workflow. ~~One possible patch can be seen here: https://code.forgejo.org/Mai-Lapyst/runner/src/branch/support-workflow-inputs~~ [PR](https://code.forgejo.org/forgejo/runner/pulls/199) ![image](/attachments/2db50c9e-898f-41cb-b698-43edeefd2573) ## Testing - Checkout PR - Setup new development runner with [this PR](https://code.forgejo.org/forgejo/runner/pulls/199) - Create a repo with a workflow (see below) - Go to the actions tab, select the workflow and see the notice as in the screenshot above - Use the button + dropdown to run the workflow - Try also running it via the api using the `` endpoint - ... - Profit! <details> <summary>Example workflow</summary> ```yaml on: workflow_dispatch: inputs: logLevel: description: 'Log Level' required: true default: 'warning' type: choice options: - info - warning - debug tags: description: 'Test scenario tags' required: false type: boolean boolean_default_true: description: 'Test scenario tags' required: true type: boolean default: true boolean_default_false: description: 'Test scenario tags' required: false type: boolean default: false number1_default: description: 'Number w. default' default: '100' type: number number2: description: 'Number w/o. default' type: number string1_default: description: 'String w. default' default: 'Hello world' type: string string2: description: 'String w/o. default' required: true type: string jobs: test: runs-on: docker steps: - uses: actions/checkout@v3 - run: whoami - run: cat /etc/issue - run: uname -a - run: date - run: echo ${{ inputs.logLevel }} - run: echo ${{ inputs.tags }} - env: GITHUB_CONTEXT: ${{ toJson(github) }} run: echo "$GITHUB_CONTEXT" - run: echo "abc" ``` </details> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/3334 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Mai-Lapyst <mai-lapyst@noreply.codeberg.org> Co-committed-by: Mai-Lapyst <mai-lapyst@noreply.codeberg.org>
74 lines
3.1 KiB
JavaScript
74 lines
3.1 KiB
JavaScript
// @ts-check
|
|
import {test, expect} from '@playwright/test';
|
|
import {login_user, load_logged_in_context} from './utils_e2e.js';
|
|
|
|
test.beforeAll(async ({browser}, workerInfo) => {
|
|
await login_user(browser, workerInfo, 'user2');
|
|
});
|
|
|
|
test('Test workflow dispatch present', async ({browser}, workerInfo) => {
|
|
const context = await load_logged_in_context(browser, workerInfo, 'user2');
|
|
/** @type {import('@playwright/test').Page} */
|
|
const page = await context.newPage();
|
|
|
|
await page.goto('/user2/test_workflows/actions?workflow=test-dispatch.yml&actor=0&status=0');
|
|
|
|
await expect(page.getByText('This workflow has a workflow_dispatch event trigger.')).toBeVisible();
|
|
|
|
const run_workflow_btn = page.locator('#workflow_dispatch_dropdown>button');
|
|
await expect(run_workflow_btn).toBeVisible();
|
|
|
|
const menu = page.locator('#workflow_dispatch_dropdown>.menu');
|
|
await expect(menu).toBeHidden();
|
|
await run_workflow_btn.click();
|
|
await expect(menu).toBeVisible();
|
|
});
|
|
|
|
test('Test workflow dispatch error: missing inputs', async ({browser}, workerInfo) => {
|
|
test.skip(workerInfo.project.name === 'Mobile Safari', 'Flaky behaviour on mobile safari; see https://codeberg.org/forgejo/forgejo/pulls/3334#issuecomment-2033383');
|
|
|
|
const context = await load_logged_in_context(browser, workerInfo, 'user2');
|
|
/** @type {import('@playwright/test').Page} */
|
|
const page = await context.newPage();
|
|
|
|
await page.goto('/user2/test_workflows/actions?workflow=test-dispatch.yml&actor=0&status=0');
|
|
await page.waitForLoadState('networkidle');
|
|
|
|
await page.locator('#workflow_dispatch_dropdown>button').click();
|
|
|
|
await page.waitForTimeout(1000);
|
|
|
|
// Remove the required attribute so we can trigger the error message!
|
|
await page.evaluate(() => {
|
|
// eslint-disable-next-line no-undef
|
|
const elem = document.querySelector('input[name="inputs[string2]"]');
|
|
elem?.removeAttribute('required');
|
|
});
|
|
|
|
await page.locator('#workflow-dispatch-submit').click();
|
|
await page.waitForLoadState('networkidle');
|
|
|
|
await expect(page.getByText('Require value for input "String w/o. default".')).toBeVisible();
|
|
});
|
|
|
|
test('Test workflow dispatch success', async ({browser}, workerInfo) => {
|
|
test.skip(workerInfo.project.name === 'Mobile Safari', 'Flaky behaviour on mobile safari; see https://codeberg.org/forgejo/forgejo/pulls/3334#issuecomment-2033383');
|
|
|
|
const context = await load_logged_in_context(browser, workerInfo, 'user2');
|
|
/** @type {import('@playwright/test').Page} */
|
|
const page = await context.newPage();
|
|
|
|
await page.goto('/user2/test_workflows/actions?workflow=test-dispatch.yml&actor=0&status=0');
|
|
await page.waitForLoadState('networkidle');
|
|
|
|
await page.locator('#workflow_dispatch_dropdown>button').click();
|
|
await page.waitForTimeout(1000);
|
|
|
|
await page.type('input[name="inputs[string2]"]', 'abc');
|
|
await page.locator('#workflow-dispatch-submit').click();
|
|
await page.waitForLoadState('networkidle');
|
|
|
|
await expect(page.getByText('Workflow run was successfully requested.')).toBeVisible();
|
|
|
|
await expect(page.locator('.run-list>:first-child .run-list-meta', {hasText: 'now'})).toBeVisible();
|
|
});
|