Ethan Lane
2e5f8c3633
# Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - Fix the unit tests "toBeCalledWith" assert being deprecated - Update the "sortBy" variable to be a string literal - Add an output to file option to the CLI - Reorganise the code so there's less repeated code - Update the tests so the CLI logic is tested quicker #138, #76, #80 ## Type of change Please delete options that are not relevant. - [x] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [x] This change requires a documentation update # How Has This Been Tested? Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration. # Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that provde my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Reviewed-on: #182 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com>
118 lines
No EOL
3.5 KiB
TypeScript
118 lines
No EOL
3.5 KiB
TypeScript
import fs from "fs";
|
|
import CliHelper from "../../src/helpers/cliHelper";
|
|
import ICliOptions from "../../src/contracts/ICliOptions";
|
|
import IReturnResult from "../../src/contracts/IReturnResult";
|
|
import OutputHelper from "../../src/helpers/outputHelper";
|
|
import { ErrorCode } from "../../src/constants/ErrorCode";
|
|
|
|
describe("Endpoint", () => {
|
|
describe("GIVEN response is successful", () => {
|
|
test("GIVEN options.o is defined, EXPECT output written to file", () => {
|
|
// Arrange
|
|
const response = {
|
|
IsSuccess: true,
|
|
} as IReturnResult;
|
|
|
|
const options = {
|
|
o: "file.txt",
|
|
} as ICliOptions;
|
|
|
|
OutputHelper.GenerateOutput = jest.fn().mockReturnValue("test output");
|
|
|
|
fs.writeFileSync = jest.fn();
|
|
|
|
console.log = jest.fn();
|
|
|
|
console.error = jest.fn();
|
|
|
|
// Act
|
|
const result = CliHelper.Endpoint(response, options);
|
|
|
|
// Assert
|
|
expect(result).toBe(0);
|
|
|
|
expect(OutputHelper.GenerateOutput).toHaveBeenCalledTimes(1);
|
|
expect(OutputHelper.GenerateOutput).toHaveBeenCalledWith(response, options);
|
|
|
|
expect(fs.writeFileSync).toHaveBeenCalledTimes(1);
|
|
expect(fs.writeFileSync).toHaveBeenCalledWith("file.txt", "test output");
|
|
|
|
expect(console.log).not.toHaveBeenCalled();
|
|
|
|
expect(console.error).not.toHaveBeenCalled();
|
|
});
|
|
|
|
test("GIVEN options.o is undefined, EXPECT output logged to console", () => {
|
|
// Arrange
|
|
const response = {
|
|
IsSuccess: true,
|
|
} as IReturnResult;
|
|
|
|
const options = {
|
|
o: undefined,
|
|
} as ICliOptions;
|
|
|
|
OutputHelper.GenerateOutput = jest.fn().mockReturnValue("test output");
|
|
|
|
fs.writeFileSync = jest.fn();
|
|
|
|
console.log = jest.fn();
|
|
|
|
console.error = jest.fn();
|
|
|
|
// Act
|
|
const result = CliHelper.Endpoint(response, options);
|
|
|
|
// Assert
|
|
expect(result).toBe(0);
|
|
|
|
expect(OutputHelper.GenerateOutput).toHaveBeenCalledTimes(1);
|
|
expect(OutputHelper.GenerateOutput).toHaveBeenCalledWith(response, options);
|
|
|
|
expect(fs.writeFileSync).not.toHaveBeenCalled();
|
|
|
|
expect(console.log).toHaveBeenCalledTimes(1);
|
|
expect(console.log).toHaveBeenCalledWith("test output");
|
|
|
|
expect(console.error).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
test("GIVEN response is failure, EXPECT error logged to console", () => {
|
|
// Arrange
|
|
const response = {
|
|
IsSuccess: false,
|
|
Error: {
|
|
Message: "error message",
|
|
Code: ErrorCode.FailedToFetchReddit,
|
|
},
|
|
} as IReturnResult;
|
|
|
|
const options = {
|
|
o: "file.txt",
|
|
} as ICliOptions;
|
|
|
|
OutputHelper.GenerateOutput = jest.fn().mockReturnValue("test output");
|
|
|
|
fs.writeFileSync = jest.fn();
|
|
|
|
console.log = jest.fn();
|
|
|
|
console.error = jest.fn();
|
|
|
|
// Act
|
|
const result = CliHelper.Endpoint(response, options);
|
|
|
|
// Assert
|
|
expect(result).toBe(1);
|
|
|
|
expect(OutputHelper.GenerateOutput).not.toHaveBeenCalled();
|
|
|
|
expect(fs.writeFileSync).not.toHaveBeenCalled();
|
|
|
|
expect(console.log).not.toHaveBeenCalled();
|
|
|
|
expect(console.error).toHaveBeenCalledTimes(1);
|
|
expect(console.error).toHaveBeenCalledWith("error message", ErrorCode.FailedToFetchReddit);
|
|
});
|
|
}); |