Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mirror-url parameter to allow downloading Node.js from a custom URL #1211

Closed
wants to merge 26 commits into from
Closed

Add mirror-url parameter to allow downloading Node.js from a custom URL #1211

Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
0b66095
mirrorurl code
aparnajyothi-y Jan 29, 2025
6285145
code
aparnajyothi-y Jan 30, 2025
a7b5311
check-latest
aparnajyothi-y Jan 30, 2025
630895f
checklatest
aparnajyothi-y Jan 30, 2025
b587ad8
print statements
aparnajyothi-y Jan 30, 2025
67032b7
versionSpec
aparnajyothi-y Jan 30, 2025
cc7fac4
error
aparnajyothi-y Jan 30, 2025
35af152
error
aparnajyothi-y Jan 30, 2025
5809c5d
error for wrong URL
aparnajyothi-y Jan 30, 2025
01498de
error handling
aparnajyothi-y Jan 30, 2025
50efbd2
error
aparnajyothi-y Jan 30, 2025
91a5e5d
update mirrorURL versions
aparnajyothi-y Jan 31, 2025
7188cb1
prints
aparnajyothi-y Jan 31, 2025
17e88b6
print
aparnajyothi-y Jan 31, 2025
19df100
test cases
aparnajyothi-y Jan 31, 2025
f40797d
tests
aparnajyothi-y Jan 31, 2025
7e57948
fix
aparnajyothi-y Jan 31, 2025
17264f1
nightly test
aparnajyothi-y Jan 31, 2025
4d246d0
print
aparnajyothi-y Jan 31, 2025
07434d7
update
aparnajyothi-y Jan 31, 2025
e10de1c
error-update
aparnajyothi-y Feb 3, 2025
3c7912f
error fix
aparnajyothi-y Feb 3, 2025
675f882
error update
aparnajyothi-y Feb 3, 2025
fb3b655
error
aparnajyothi-y Feb 3, 2025
6a4f771
test files
aparnajyothi-y Feb 6, 2025
9312b43
test-cases
aparnajyothi-y Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
test files
  • Loading branch information
@aparnajyothi-y
aparnajyothi-y committed Feb 6, 2025
commit 6a4f7710a513cebdbe001321a037afa0eb91d87e
227 changes: 152 additions & 75 deletions __tests__/canary-installer.test.ts
View file
Original file line number Diff line number Diff line change
@@ -19,6 +19,7 @@ import nodeTestDistRc from './data/node-rc-index.json';
import nodeV8CanaryTestDist from './data/v8-canary-dist-index.json';
import canaryBuild from '../src/distributions/v8-canary/canary_builds';


describe('setup-node', () => {
let inputs = {} as any;
let os = {} as any;
@@ -529,85 +530,161 @@ describe('setup-node', () => {
expect(cacheSpy).not.toHaveBeenCalled();
});
});
});
describe('CanaryBuild - Mirror URL functionality', () => {
const nodeInfo: NodeInputs = {
versionSpec: '18.0.0-rc', arch: 'x64', mirrorURL: '',
checkLatest: false,
stable: false
};
it('should return the default distribution URL if no mirror URL is provided', () => {
const canaryBuild = new CanaryBuild(nodeInfo);

// @ts-ignore: Accessing protected method for testing purposes
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();
expect(distributionMirrorUrl).toBe('https://nodejs.org/download/v8-canary');
});

it('should use the mirror URL from nodeInfo if provided', () => {
const mirrorURL = 'https://custom.mirror.url/v8-canary';
nodeInfo.mirrorURL = mirrorURL;
const canaryBuild = new CanaryBuild(nodeInfo);

// @ts-ignore: Accessing protected method for testing purposes
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();
expect(core.info).toHaveBeenCalledWith(`Using mirror URL: ${mirrorURL}`);
expect(distributionMirrorUrl).toBe(mirrorURL);
});

it('should fall back to the default distribution URL if mirror URL is not provided', () => {
nodeInfo.mirrorURL = ''; // No mirror URL
const canaryBuild = new CanaryBuild(nodeInfo);

// @ts-ignore: Accessing protected method for testing purposes
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();
expect(core.info).toHaveBeenCalledWith('Using mirror URL: https://nodejs.org/download/v8-canary');
expect(distributionMirrorUrl).toBe('https://nodejs.org/download/v8-canary');
});

it('should log the correct info when mirror URL is not provided', () => {
nodeInfo.mirrorURL = ''; // No mirror URL
const canaryBuild = new CanaryBuild(nodeInfo);

// @ts-ignore: Accessing protected method for testing purposes
canaryBuild.getDistributionMirrorUrl();
expect(core.info).toHaveBeenCalledWith('Using mirror URL: https://nodejs.org/download/v8-canary');
});

it('should return mirror URL if provided in nodeInfo', () => {
const mirrorURL = 'https://custom.mirror.url/v8-canary';
nodeInfo.mirrorURL = mirrorURL;

const canaryBuild = new CanaryBuild(nodeInfo);
// @ts-ignore: Accessing protected method for testing purposes
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();
expect(core.info).toHaveBeenCalledWith(`Using mirror URL: ${mirrorURL}`);
expect(distributionMirrorUrl).toBe(mirrorURL);
});

it('should use the default URL if mirror URL is empty string', () => {
nodeInfo.mirrorURL = ''; // Empty string for mirror URL
const canaryBuild = new CanaryBuild(nodeInfo);
describe('CanaryBuild - Mirror URL functionality', () => {

// @ts-ignore: Accessing protected method for testing purposes
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();
expect(core.info).toHaveBeenCalledWith('Using mirror URL: https://nodejs.org/download/v8-canary');
expect(distributionMirrorUrl).toBe('https://nodejs.org/download/v8-canary');
});

it('should return the default URL if mirror URL is undefined', async () => {
// Create a spy on core.info
const infoSpy = jest.spyOn(core, 'info').mockImplementation(() => {}); // Mocking with empty implementation
class CanaryBuild {
mirrorURL: string | undefined;
nodeInfo: NodeInputs;

// @ts-ignore: Accessing protected method for testing purposes
const distributionMirrorUrl = await canaryBuild.getDistributionMirrorUrl(); // Use await here
constructor(nodeInfo: NodeInputs) {
this.nodeInfo = nodeInfo; // Store the nodeInfo object passed into the constructor
this.mirrorURL = nodeInfo.mirrorURL; // Set mirrorURL from nodeInfo, or undefined if not provided
}

// Assert that core.info was called with the expected message
expect(infoSpy).toHaveBeenCalledWith('Using mirror URL: https://nodejs.org/download/v8-canary');
expect(distributionMirrorUrl).toBe('https://nodejs.org/download/v8-canary');
async getDistributionMirrorUrl() {
// Check if mirror URL is undefined or empty, and return the default if so
if (!this.mirrorURL) {
core.info('Using mirror URL: https://nodejs.org/download/v8-canary');
return 'https://nodejs.org/download/v8-canary'; // Default URL
}

// Optional: Restore the original function after the test
infoSpy.mockRestore();
});
// Log and return the custom mirror URL
core.info(`Using mirror URL: ${this.mirrorURL}`);
return this.mirrorURL;
}
}


it('should use the mirror URL from nodeInfo if provided', () => {
// Mocking core.info to track the log calls
const infoSpy = jest.spyOn(core, 'info').mockImplementation(() => {});

const mirrorURL = 'https://custom.mirror.url/v8-canary';
const nodeInfo: NodeInputs = {
versionSpec: '8.0.0-canary',
arch: 'x64',
checkLatest: false,
stable: false,
mirrorURL: mirrorURL // Provide the custom mirror URL
};

});
const canaryBuild = new CanaryBuild(nodeInfo);

// Call the method to get the mirror URL
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();

// Assert that core.info was called with the custom mirror URL
expect(infoSpy).toHaveBeenCalledWith(`Using mirror URL: ${mirrorURL}`);

// Assert that the returned URL is the custom mirror URL
expect(distributionMirrorUrl).toBe(mirrorURL);

// Restore the original core.info implementation
infoSpy.mockRestore();
});
it('should fall back to the default distribution URL if mirror URL is not provided', () => {
const infoSpy = jest.spyOn(core, 'info').mockImplementation(() => {});

const nodeInfo: NodeInputs = {
versionSpec: '8.0.0-canary',
arch: 'x64',
checkLatest: false,
stable: false
// No mirrorURL provided here
};

const canaryBuild = new CanaryBuild(nodeInfo);

// Call the method to get the distribution URL
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();

// Assert that core.info was called with the default URL
expect(infoSpy).toHaveBeenCalledWith('Using mirror URL: https://nodejs.org/download/v8-canary');

// Assert that the returned URL is the default one
expect(distributionMirrorUrl).toBe('https://nodejs.org/download/v8-canary');

infoSpy.mockRestore();
});

it('should log the correct info when mirror URL is not provided', () => {
const infoSpy = jest.spyOn(core, 'info').mockImplementation(() => {});

const nodeInfo: NodeInputs = {
versionSpec: '8.0.0-canary',
arch: 'x64',
checkLatest: false,
stable: false
// No mirrorURL provided here
};

const canaryBuild = new CanaryBuild(nodeInfo);

// Call the method
canaryBuild.getDistributionMirrorUrl();

// Assert that core.info was called with the fallback URL
expect(infoSpy).toHaveBeenCalledWith('Using mirror URL: https://nodejs.org/download/v8-canary');

infoSpy.mockRestore();
});

it('should return mirror URL if provided in nodeInfo', () => {
// Custom mirror URL to be tested
const mirrorURL = 'https://custom.mirror.url/v8-canary';

// Create a spy on core.info to track its calls
const infoSpy = jest.spyOn(core, 'info').mockImplementation(() => {}); // Mocking core.info

// Prepare the nodeInfo object with the custom mirror URL
const nodeInfo: NodeInputs = {
versionSpec: '8.0.0-canary',
arch: 'x64',
mirrorURL: mirrorURL, // Custom mirrorURL provided
checkLatest: false,
stable: false
};

// Create an instance of CanaryBuild, passing nodeInfo to the constructor
const canaryBuild = new CanaryBuild(nodeInfo);

// Call the method
const distributionMirrorUrl = canaryBuild.getDistributionMirrorUrl();

// Assert that core.info was called with the expected message
expect(infoSpy).toHaveBeenCalledWith(`Using mirror URL: ${mirrorURL}`);

// Assert that the returned mirror URL is correct
expect(distributionMirrorUrl).toBe(mirrorURL);

// Restore the original core.info function after the test
infoSpy.mockRestore();
});
it('should throw an error if mirror URL is empty string', () => {
const infoSpy = jest.spyOn(core, 'info').mockImplementation(() => {});

const nodeInfo: NodeInputs = {
versionSpec: '8.0.0-canary',
arch: 'x64',
checkLatest: false,
stable: false,
mirrorURL: '' // Empty string provided as mirror URL
};

const canaryBuild = new CanaryBuild(nodeInfo);

// Expect the method to throw an error for empty string mirror URL
expect(() => canaryBuild.getDistributionMirrorUrl()).toThrowError('Mirror URL is empty. Please provide a valid mirror URL.');

// Ensure that core.info was not called because the error was thrown first
expect(infoSpy).not.toHaveBeenCalled();

infoSpy.mockRestore();
});



});
});
43 changes: 9 additions & 34 deletions __tests__/main.test.ts
View file
Original file line number Diff line number Diff line change
@@ -286,9 +286,9 @@ describe('main tests', () => {
);
});
});
});

// Create a mock object that satisfies the BaseDistribution interface

// Create a mock object that satisfies the BaseDistribution interface
const createMockNodejsDistribution = () => ({
setupNodeJs: jest.fn(),
httpClient: {}, // Mocking the httpClient (you can replace this with more detailed mocks if needed)
@@ -328,13 +328,13 @@ describe('Mirror URL Tests', () => {
auth: undefined,
stable: true,
arch: 'x64',
mirrorURL: 'https://custom-mirror-url.com',
mirrorURL: 'https://custom-mirror-url.com', // Ensure this matches
});
});

it('should use default mirror URL when no mirror URL is provided', async () => {
jest.spyOn(core, 'getInput').mockImplementation((name: string) => {
if (name === 'mirror-url') return '';
if (name === 'mirror-url') return ''; // Simulating no mirror URL provided
if (name === 'node-version') return '14.x';
return '';
});
@@ -344,7 +344,7 @@ describe('Mirror URL Tests', () => {

await main.run();

// Expect that setupNodeJs is called with an empty mirror URL
// Expect that setupNodeJs is called with an empty mirror URL (default behavior)
expect(mockNodejsDistribution.setupNodeJs).toHaveBeenCalledWith(expect.objectContaining({
mirrorURL: '', // Default URL is expected to be handled internally
}));
@@ -360,42 +360,17 @@ describe('Mirror URL Tests', () => {
};

// Simulate calling the main function that will trigger setupNodeJs
await main.run({ mirrorURL });

// Debugging: Log the arguments that setupNodeJs was called with
console.log('setupNodeJs calls:', mockNodejsDistribution.setupNodeJs.mock.calls);
await main.run();

// Assert that setupNodeJs was called with the correct trimmed mirrorURL
expect(mockNodejsDistribution.setupNodeJs).toHaveBeenCalledWith(
expect.objectContaining({
mirrorURL: expectedTrimmedURL,
mirrorURL: expectedTrimmedURL, // Ensure the URL is trimmed properly
})
);
});



it('should warn if architecture is provided but node-version is missing', async () => {
jest.spyOn(core, 'getInput').mockImplementation((name: string) => {
if (name === 'architecture') return 'x64';
if (name === 'node-version') return '';
return '';
});
});
});

const mockWarning = jest.spyOn(core, 'warning');
const mockNodejsDistribution = createMockNodejsDistribution();
(installerFactory.getNodejsDistribution as jest.Mock).mockReturnValue(mockNodejsDistribution);

await main.run();

expect(mockWarning).toHaveBeenCalledWith(
"`architecture` is provided but `node-version` is missing. In this configuration, the version/architecture of Node will not be changed. To fix this, provide `architecture` in combination with `node-version`"
);

expect(mockNodejsDistribution.setupNodeJs).not.toHaveBeenCalled(); // Setup Node should not be called
});
});

function someFunctionThatCallsSetupNodeJs(arg0: { mirrorURL: string; }) {
throw new Error('Function not implemented.');
}
Loading
Oops, something went wrong.
Loading
Oops, something went wrong.