languageservices/languageserver/src/utils/action-metadata.test.ts at 751cb5a940d12f029890c6c6b44b0593f7cd40e8 · actions/languageservices · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
import {Octokit} from "@octokit/rest";
import fetchMock from "fetch-mock";
import {fetchActionMetadata} from "./action-metadata";
import {TTLCache} from "./cache";

// A simplified version of the action.yml file from actions/checkout
const actionMetadataContent = `
name: 'Checkout'
description: 'Checkout a Git repository at a particular version'
inputs:
  repository:
    description: Repository name with owner. For example, actions/checkout
    default: \${{ github.repository }}
runs:
  using: node24
  main: dist/index.js
  post: dist/index.js
`;

// Based on https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3
const actionMetadata = {
  name: "action.yml",
  path: "action.yml",
  sha: "cab09ebd3a964aba67b57f9727f5f6fff1372b04",
  size: 3649,
  url: "https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3",
  html_url: "https://github.com/actions/checkout/blob/v3/action.yml",
  git_url: "https://api.github.com/repos/actions/checkout/git/blobs/cab09ebd3a964aba67b57f9727f5f6fff1372b04",
  download_url: "https://raw.githubusercontent.com/actions/checkout/v3/action.yml",
  type: "file",
  content: Buffer.from(actionMetadataContent).toString("base64"),
  encoding: "base64",
  _links: {
    self: "https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3",
    git: "https://api.github.com/repos/actions/checkout/git/blobs/cab09ebd3a964aba67b57f9727f5f6fff1372b04",
    html: "https://github.com/actions/checkout/blob/v3/action.yml"
  }
};

async function fetchActionWithMock(mock: fetchMock.FetchMockSandbox, cache?: TTLCache) {
  return await fetchActionMetadata(
    new Octokit({
      request: {
        fetch: mock
      }
    }),
    cache || new TTLCache(),
    {
      owner: "actions",
      name: "checkout",
      ref: "v3"
    }
  );
}

describe("fetchActionMetadata", () => {
  it("fetches action metadata", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionMetadata);

    const metadata = await fetchActionWithMock(mock);

    expect(metadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );
  });

  it("fetches action metadata at a path", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/some-path%2Faction.yml?ref=v3", actionMetadata);

    const metadata = await fetchActionMetadata(
      new Octokit({
        request: {
          fetch: mock
        }
      }),
      new TTLCache(),
      {
        owner: "actions",
        name: "checkout",
        ref: "v3",
        path: "some-path"
      }
    );

    expect(metadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );
  });

  it("falls back to .yaml extension on 404", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", 404)
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yaml?ref=v3", actionMetadata);

    const metadata = await fetchActionWithMock(mock);

    expect(metadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );
  });

  it("fetches action metadata at a path with a .yaml extension", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/some-path%2Faction.yml?ref=v3", 404)
      .getOnce("https://api.github.com/repos/actions/checkout/contents/some-path%2Faction.yaml?ref=v3", actionMetadata);

    const metadata = await fetchActionMetadata(
      new Octokit({
        request: {
          fetch: mock
        }
      }),
      new TTLCache(),
      {
        owner: "actions",
        name: "checkout",
        ref: "v3",
        path: "some-path"
      }
    );

    expect(metadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );
  });

  it("does not fall back for other errors", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", 403);

    const metadata = await fetchActionWithMock(mock);

    expect(metadata).toBeUndefined();
  });

  it("handles invalid actions", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", 404)
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yaml?ref=v3", 404);

    const metadata = await fetchActionWithMock(mock);

    expect(metadata).toBeUndefined();
  });

  it("caches action metadata", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionMetadata);

    const cache = new TTLCache();

    const metadata = await fetchActionWithMock(mock, cache);
    expect(metadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );

    const cachedMetadata = await fetchActionWithMock(mock, cache);
    expect(cachedMetadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );
  });

  it("caches action metadata", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionMetadata);

    const cache = new TTLCache();

    const metadata = await fetchActionWithMock(mock, cache);
    expect(metadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );

    const cachedMetadata = await fetchActionWithMock(mock, cache);
    expect(cachedMetadata?.inputs?.repository?.description).toEqual(
      "Repository name with owner. For example, actions/checkout"
    );
  });

  it("ignores directories", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", [actionMetadata]);

    const metadata = await fetchActionWithMock(mock);

    expect(metadata).toBeUndefined();
  });

  it("ignores non-files", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", {
        type: "not-a-file",
        content: Buffer.from(actionMetadataContent).toString("base64")
      });

    const metadata = await fetchActionWithMock(mock);

    expect(metadata).toBeUndefined();
  });

  it("ignores responses without content", async () => {
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", {
        type: "file"
      });

    const metadata = await fetchActionWithMock(mock);

    expect(metadata).toBeUndefined();
  });

  it("handles emojis in action descriptions", async () => {
    const actionMetadataContent = `
name: 'Checkout'
description: 'Checkout a Git repository at a particular version'
inputs:
  repository:
    description: 📦 Repository 📦 name with owner. For example, actions/checkout
    default: \${{ github.repository }}
runs:
  using: node24
  main: dist/index.js
  post: dist/index.js
`;
    const mock = fetchMock
      .sandbox()
      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", {
        type: "file",
        content: Buffer.from(actionMetadataContent).toString("base64")
      });

    const metadata = await fetchActionWithMock(mock);

    expect(metadata?.inputs?.repository?.description).toEqual(
      "📦 Repository 📦 name with owner. For example, actions/checkout"
    );
  });
});