1
0
Fork 0
mirror of https://github.com/actions/toolkit synced 2025-05-09 00:22:56 +00:00

tests and fix bug for retry

This commit is contained in:
Bethany 2023-08-08 12:49:05 -07:00
parent af1621025d
commit e85cd96d85
2 changed files with 136 additions and 106 deletions

View file

@ -5,17 +5,7 @@ import * as config from "../src/internal/shared/config"
import { createArtifactTwirpClient } from "../src/internal/shared/artifact-twirp-client"
import * as core from "@actions/core"
const mockPost = jest.fn()
jest.mock("@actions/http-client", () => {
return {
HttpClient: jest.fn().mockImplementation(() => {
return {
post: mockPost
}
})
}
})
jest.mock("@actions/http-client")
describe("artifact-http-client", () => {
beforeAll(() => {
@ -29,8 +19,7 @@ describe("artifact-http-client", () => {
})
beforeEach(() => {
mockPost.mockClear();
jest.clearAllMocks()
})
it("should successfully create a client", () => {
@ -39,21 +28,7 @@ describe("artifact-http-client", () => {
})
it("should make a request", async () => {
/*
const mockHttpClient = (HttpClient as unknown as jest.Mock).mockImplementation(() => {
return {
post: () => {
const msg = new http.IncomingMessage(new net.Socket())
msg.statusCode = 200
return {
message: msg,
readBody: () => {return Promise.resolve(`{"ok": true, "signedUploadUrl": "http://localhost:8080/lol/upload"}`)}
}
}
}
})
*/
mockPost.mockImplementationOnce(() => {
const mockPost = jest.fn(() => {
const msg = new http.IncomingMessage(new net.Socket())
msg.statusCode = 200
return {
@ -61,6 +36,11 @@ describe("artifact-http-client", () => {
readBody: () => {return Promise.resolve(`{"ok": true, "signedUploadUrl": "http://localhost:8080/upload"}`)}
}
})
const mockHttpClient = (HttpClient as unknown as jest.Mock).mockImplementation(() => {
return {
post: mockPost
}
})
const client = createArtifactTwirpClient("upload")
const artifact = await client.CreateArtifact(
@ -72,6 +52,7 @@ describe("artifact-http-client", () => {
}
)
expect(mockHttpClient).toHaveBeenCalledTimes(1)
expect(mockPost).toHaveBeenCalledTimes(1)
expect(artifact).toBeDefined()
expect(artifact.ok).toBe(true)
@ -79,32 +60,8 @@ describe("artifact-http-client", () => {
})
it("should retry if the request fails", async () => {
/*
const mockPost = jest.fn(() => {
const msg = new http.IncomingMessage(new net.Socket())
if (mockPost.mock.calls.length > 1) {
msg.statusCode = 200
return {
message: msg,
readBody: () => {return Promise.resolve(`{"ok": true, "signedUploadUrl": "http://localhost:8080/upload"}`)}
}
}
msg.statusCode = 500
return {
message: msg,
readBody: () => {return Promise.resolve(`{"ok": false}`)}
}
})
*/
mockPost.mockImplementationOnce(() => {
const msgFailed = new http.IncomingMessage(new net.Socket())
msgFailed.statusCode = 500
return {
message: msgFailed,
readBody: () => {return Promise.resolve(`{"ok": false}`)}
}
}).mockImplementationOnce(() => {
const mockPost = jest
.fn(() => {
const msgSucceeded = new http.IncomingMessage(new net.Socket())
msgSucceeded.statusCode = 200
return {
@ -112,51 +69,27 @@ describe("artifact-http-client", () => {
readBody: () => {return Promise.resolve(`{"ok": true, "signedUploadUrl": "http://localhost:8080/upload"}`)}
}
})
/*
mockPost.mockImplementationOnce(() => {
const msg = new http.IncomingMessage(new net.Socket())
msg.statusCode = 500
.mockImplementationOnce(() => {
const msgFailed = new http.IncomingMessage(new net.Socket())
msgFailed.statusCode = 500
msgFailed.statusMessage = "Internal Server Error"
return {
message: msg,
message: msgFailed,
readBody: () => {return Promise.resolve(`{"ok": false}`)}
}
})
mockPost.mockImplementation(() => {
const msg = new http.IncomingMessage(new net.Socket())
msg.statusCode = 200
return {
message: msg,
readBody: () => {return Promise.resolve(`{"ok": true, "signedUploadUrl": "http://localhost:8080/lol/upload"}`)}
}
})
jest.mock("@actions/http-client", () => {
return jest.fn().mockImplementation(() => {
return {
post: mockPost
}
})
})
jest.mock("@actions/http-client", () => {
const mockHttpClient = (HttpClient as unknown as jest.Mock).mockImplementation(() => {
return {
HttpClient: jest.fn().mockImplementation(() => {
return {
post: mockPost
}
})
post: mockPost
}
})
jest.mock("@actions/http-client", () => {
return jest.fn().mockImplementation(() => {
return {
post: mockPost
}
})
})
*/
const client = createArtifactTwirpClient("upload")
const client = createArtifactTwirpClient(
"upload",
5, // retry 5 times
1, // wait 1 ms
1.5 // backoff factor
)
const artifact = await client.CreateArtifact(
{
workflowRunBackendId: "1234",
@ -166,10 +99,85 @@ describe("artifact-http-client", () => {
}
)
expect(mockHttpClient).toHaveBeenCalledTimes(1)
expect(artifact).toBeDefined()
expect(artifact.ok).toBe(true)
expect(artifact.signedUploadUrl).toBe("http://localhost:8080/upload")
expect(mockPost).toHaveBeenCalledTimes(2)
})
it("should fail if the request fails 5 times", async () => {
const mockPost = jest
.fn(() => {
const msgFailed = new http.IncomingMessage(new net.Socket())
msgFailed.statusCode = 500
msgFailed.statusMessage = "Internal Server Error"
return {
message: msgFailed,
readBody: () => {return Promise.resolve(`{"ok": false}`)}
}
})
const mockHttpClient = (HttpClient as unknown as jest.Mock).mockImplementation(() => {
return {
post: mockPost
}
})
const client = createArtifactTwirpClient(
"upload",
5, // retry 5 times
1, // wait 1 ms
1.5 // backoff factor
)
await expect(async () => {
await client.CreateArtifact(
{
workflowRunBackendId: "1234",
workflowJobRunBackendId: "5678",
name: "artifact",
version: 4
}
)
}).rejects.toThrowError("Failed to make request after 5 attempts: Failed request: (500) Internal Server Error")
expect(mockHttpClient).toHaveBeenCalledTimes(1)
expect(mockPost).toHaveBeenCalledTimes(5)
})
it("should fail immediately if there is a non-retryable error", async () => {
const mockPost = jest
.fn(() => {
const msgFailed = new http.IncomingMessage(new net.Socket())
msgFailed.statusCode = 401
msgFailed.statusMessage = "Unauthorized"
return {
message: msgFailed,
readBody: () => {return Promise.resolve(`{"ok": false}`)}
}
})
const mockHttpClient = (HttpClient as unknown as jest.Mock).mockImplementation(() => {
return {
post: mockPost
}
})
const client = createArtifactTwirpClient(
"upload",
5, // retry 5 times
1, // wait 1 ms
1.5 // backoff factor
)
await expect(async () => {
await client.CreateArtifact(
{
workflowRunBackendId: "1234",
workflowJobRunBackendId: "5678",
name: "artifact",
version: 4
}
)
}).rejects.toThrowError("Received non-retryable error: Failed request: (401) Unauthorized")
expect(mockHttpClient).toHaveBeenCalledTimes(1)
expect(mockPost).toHaveBeenCalledTimes(1)
})
})