languageservices/actions-languageservice/src/hover.reusable-workflow.test.ts

import {hover} from "./hover";
import {testHoverConfig} from "./hover.test";
import {getPositionFromCursor} from "./test-utils/cursor-position";

describe("hover on reusable workflows", () => {
  it("hover on job input with description", async () => {
    const input = `
on: push

jobs:
  build:
    uses: ./reusable-workflow-with-inputs.yaml
    with:
      us|ername:
`;
    const result = await hover(...getPositionFromCursor(input), testHoverConfig("username", "scalar-needs-context"));
    expect(result).not.toBeUndefined();
    expect(result?.contents).toEqual(
      "A username passed from the caller workflow\n\n**Context:** github, inputs, vars, needs, strategy, matrix"
    );
  });

  it("hover on job input without description", async () => {
    const input = `
on: push

jobs:
  build:
    uses: ./reusable-workflow-with-inputs-no-description.yaml
    with:
      us|ername:
`;
    const result = await hover(...getPositionFromCursor(input));
    expect(result).not.toBeUndefined();
    expect(result?.contents).toEqual("**Context:** github, inputs, vars, needs, strategy, matrix");
  });

  it("hover on job output with description", async () => {
    const input = `
on: push

jobs:
  build:
    uses: ./reusable-workflow-with-outputs.yaml
  echo_outputs:
    runs-on: ubuntu-latest
    needs: build
    steps:
      - run: echo \${{ needs.build.outputs.bu|ild_id }}
`;

    const result = await hover(
      ...getPositionFromCursor(input),
      testHoverConfig("", "string-steps-context")
    );
    expect(result).not.toBeUndefined();
    expect(result?.contents).toEqual(
      "The resulting build ID\n\n**Context:** github, inputs, vars, needs, strategy, matrix, secrets, steps, job, runner, env, hashFiles(1,255)"
    );
  });
});