Compare commits

...

5 Commits

Author SHA1 Message Date
Mikey Lombardi (He/Him)
23c4ea5359
Merge b7e8a5bdba into 3a287949d3 2024-11-15 12:31:25 -07:00
dependabot[bot]
3a287949d3
ci: bump codecov/codecov-action from 4 to 5 (#660)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-15 11:27:10 +09:00
Michael T Lombardi
b7e8a5bdba
(GH-608) Add getConventions and refactor
This commit introduces the getConventions function, which does a one-time calculation
for the changes in packaging conventions to propagate to the getArch and getOS
functions.

It updates those functions and the installer code to leverage the conventions.

Finally, it updates the test arrangement for getArch and getOS to use test cases
instead of repeating the same test over and over and adds unit tests for the new
getConventions function.
2022-10-13 23:13:33 -05:00
codefactor-io
c7d0025d39
[CodeFactor] Apply fixes to commit e70fd02 2022-10-06 13:13:28 +00:00
Michael T Lombardi
e70fd029fa
(GH-608) Fix package url for v0.102.0 & v0.103.0
Prior to this change, the URL building for versions of hugo was
deterministic as the URLs for the packages were set to a
project-specific standard. That URL creation began to fail for macOS in
[0.102.0] and for Windows in [0.103.0]. It does not fail for Linux
because the hugo releases for Linux continue to include the old package
naming as an alias.

This change:

- Updates the `get-os` function to take the hugo version as additional
  input, altering the return value based on the version.
- Updates the `get-arch` function to take the operating system name and
  hugo version as additional input, altering the return value based on
  both. Including the OS name is required for handling macOS.
- Fixes #608
- Fixes #605

[0.102.0]: https://github.com/gohugoio/hugo/releases/tag/v0.102.0
[0.103.0]: https://github.com/gohugoio/hugo/releases/tag/v0.103.0
2022-10-06 08:09:56 -05:00
8 changed files with 314 additions and 25 deletions

View File

@ -52,4 +52,4 @@ jobs:
name: coverage-${{ matrix.os }}
path: coverage
- uses: codecov/codecov-action@v4
- uses: codecov/codecov-action@v5

View File

@ -1,15 +1,121 @@
import getArch from '../src/get-arch';
describe('getArch', () => {
test('processor architecture', () => {
expect(getArch('x64')).toBe('64bit');
expect(getArch('arm')).toBe('ARM');
expect(getArch('arm64')).toBe('ARM64');
const groups = [
{
condition: 'when hugo version < 0.102.0',
conventions: {
arch: {
darwinUniversal: false,
dropped32BitSupport: false,
standardizedNaming: false,
},
os: {
renamedMacOS: false,
downcasedAll: false
}
},
tests: [
{ arch: 'x64', os: 'linux', expected: '64bit' },
{ arch: 'x64', os: 'macOS', expected: '64bit' },
{ arch: 'x64', os: 'windows', expected: '64bit' },
{ arch: 'arm', os: 'linux', expected: 'ARM' },
{ arch: 'arm', os: 'macOS', expected: 'ARM' },
{ arch: 'arm', os: 'windows', expected: 'ARM' },
{ arch: 'arm64', os: 'linux', expected: 'ARM64' },
{ arch: 'arm64', os: 'macOS', expected: 'ARM64' },
{ arch: 'arm64', os: 'windows', expected: 'ARM64' },
]
},
{
condition: 'when hugo version === 0.102.z',
conventions: {
arch: {
darwinUniversal: true,
dropped32BitSupport: true,
standardizedNaming: false,
},
os: {
renamedMacOS: true,
downcasedAll: false
}
},
tests: [
{ arch: 'x64', os: 'linux', expected: '64bit' },
{ arch: 'x64', os: 'macOS', expected: 'universal' },
{ arch: 'x64', os: 'windows', expected: '64bit' },
{ arch: 'arm', os: 'linux', throws: true },
{ arch: 'arm', os: 'macOS', expected: 'universal' },
{ arch: 'arm', os: 'windows', throws: true },
{ arch: 'arm64', os: 'linux', expected: 'ARM64' },
{ arch: 'arm64', os: 'macOS', expected: 'universal' },
{ arch: 'arm64', os: 'windows', expected: 'ARM64' },
]
},
{
condition: 'when hugo version >= 0.103.0',
conventions: {
arch: {
darwinUniversal: true,
dropped32BitSupport: true,
standardizedNaming: true,
},
os: {
renamedMacOS: true,
downcasedAll: true
}
},
tests: [
{ arch: 'x64', os: 'linux', expected: 'amd64' },
{ arch: 'x64', os: 'macOS', expected: 'universal' },
{ arch: 'x64', os: 'windows', expected: 'amd64' },
{ arch: 'arm', os: 'linux', throws: true },
{ arch: 'arm', os: 'macOS', expected: 'universal' },
{ arch: 'arm', os: 'windows', throws: true },
{ arch: 'arm64', os: 'linux', expected: 'arm64' },
{ arch: 'arm64', os: 'macOS', expected: 'universal' },
{ arch: 'arm64', os: 'windows', expected: 'arm64' },
]
},
{
condition: 'when the architecture is unsupported for the action',
conventions: {
arch: {
darwinUniversal: false,
dropped32BitSupport: false,
standardizedNaming: false,
},
os: {
renamedMacOS: false,
downcasedAll: false
}
},
tests: [
{ arch: 'mips', os: 'linux', throws: true}
]
}
].map(function (group) {
group.tests = group.tests.map(function (example) {
return Object.assign(example, {
toString: function () {
let name = `${example.os} on ${example.arch} `
name += example?.throws ? 'throws as not supported' : `returns ${example.expected}`
return name;
}
});
})
return Object.assign(group, { toString: function () { return group.condition } });
});
test('exception', () => {
describe.each(groups)('%s', ({ conventions, tests }) => {
test.each(tests)('%s', ({ arch, os, throws, expected }) => {
if (throws) {
expect(() => {
getArch('mips');
}).toThrowError('mips is not supported');
});
getArch(arch, os, conventions)
}).toThrow(`${arch} is not supported`);
} else {
expect(getArch(arch, os, conventions)).toBe(expected);
}
})
})
});

View File

@ -0,0 +1,57 @@
import getConventions from "../src/get-conventions";
describe('getConventions()', () => {
const groups = [
{
condition: 'when hugo version < 0.102.0',
version: '0.101.0',
expected: {
arch: {
darwinUniversal: false,
dropped32BitSupport: false,
standardizedNaming: false,
},
os: {
renamedMacOS: false,
downcasedAll: false
}
}
},
{
condition: 'when hugo version === 0.102.z',
version: '0.102.0',
expected: {
arch: {
darwinUniversal: true,
dropped32BitSupport: true,
standardizedNaming: false,
},
os: {
renamedMacOS: true,
downcasedAll: false
}
}
},
{
condition: 'when hugo version >= 0.103.0',
version: '0.103.0',
expected: {
arch: {
darwinUniversal: true,
dropped32BitSupport: true,
standardizedNaming: true,
},
os: {
renamedMacOS: true,
downcasedAll: true
}
}
}
].map(function (group) {
return Object.assign(group, { toString: function () { return group.condition } });
});
test.each(groups)('%s', ({ expected, version }) => {
expect(getConventions(version)).toEqual(expected);
});
});

View File

@ -1,15 +1,96 @@
import getOS from '../src/get-os';
describe('getOS', () => {
test('os type', () => {
expect(getOS('linux')).toBe('Linux');
expect(getOS('darwin')).toBe('macOS');
expect(getOS('win32')).toBe('Windows');
const groups = [
{
condition: 'when hugo version < 0.102.0',
conventions: {
arch: {
darwinUniversal: false,
dropped32BitSupport: false,
standardizedNaming: false,
},
os: {
renamedMacOS: false,
downcasedAll: false
}
},
tests: [
{ os: 'linux', expected: 'Linux' },
{ os: 'darwin', expected: 'macOS' },
{ os: 'win32', expected: 'Windows' },
],
},
{
condition: 'when hugo version === 0.102.z',
conventions: {
arch: {
darwinUniversal: true,
dropped32BitSupport: true,
standardizedNaming: false,
},
os: {
renamedMacOS: true,
downcasedAll: false
}
},
tests: [
{ os: 'linux', expected: 'Linux' },
{ os: 'darwin', expected: 'darwin' },
{ os: 'win32', expected: 'Windows' },
],
},
{
condition: 'when hugo version >= 0.103.0',
conventions: {
arch: {
darwinUniversal: true,
dropped32BitSupport: true,
standardizedNaming: true,
},
os: {
renamedMacOS: true,
downcasedAll: true
}
},
tests: [
{ os: 'linux', expected: 'linux' },
{ os: 'darwin', expected: 'darwin' },
{ os: 'win32', expected: 'windows' },
],
}
].map(function (group) {
group.tests = group.tests.map(function (example) {
return Object.assign(example, {
toString: function () {
return `${example.os} returns ${example.expected}`
}
});
})
return Object.assign(group, { toString: function () { return group.condition } });
});
describe.each(groups)('%s', ({ conventions, tests }) => {
test.each(tests)('%s', ({ os, expected }) => {
expect(getOS(os, conventions)).toBe(expected);
})
});
test('exception', () => {
const conventions = {
arch: {
darwinUniversal: false,
dropped32BitSupport: false,
standardizedNaming: false,
},
os: {
renamedMacOS: false,
downcasedAll: false
}
}
expect(() => {
getOS('centos');
}).toThrowError('centos is not supported');
getOS('centos', conventions);
}).toThrow('centos is not supported');
});
});

View File

@ -1,11 +1,21 @@
export default function getArch(arch: string): string {
import { conventions } from "./get-conventions";
export default function getArch(arch: string, os: string, conventions: conventions): string {
if (os == 'darwin' || os == 'macOS' && conventions.arch.darwinUniversal) {
return 'universal'
}
switch (arch) {
case 'x64':
return '64bit';
return conventions.arch.standardizedNaming ? 'amd64': '64bit' ;
case 'arm':
if (conventions.arch.dropped32BitSupport) {
throw new Error(`${arch} is not supported`);
}
return 'ARM';
case 'arm64':
return 'ARM64';
return conventions.arch.standardizedNaming ? 'arm64' : 'ARM64';
default:
throw new Error(`${arch} is not supported`);
}

29
src/get-conventions.ts Normal file
View File

@ -0,0 +1,29 @@
export interface conventions {
arch: {
darwinUniversal: boolean,
dropped32BitSupport: boolean,
standardizedNaming: boolean
},
os: {
renamedMacOS: boolean,
downcasedAll: boolean
}
}
export default function getConventions(version: string,): conventions {
const segments = version.split('.').map(s => parseInt(s));
const stableOrNewer = segments[0] > 0;
const newerThan103 = stableOrNewer || segments[1] >= 103
const newerThan102 = stableOrNewer || segments[1] >= 102
return {
arch: {
darwinUniversal: newerThan102,
dropped32BitSupport: newerThan102,
standardizedNaming: newerThan103
},
os: {
renamedMacOS: newerThan102,
downcasedAll: newerThan103
}
}
}

View File

@ -1,11 +1,14 @@
export default function getOS(platform: string): string {
import { conventions } from "./get-conventions";
export default function getOS(platform: string, conventions: conventions): string {
switch (platform) {
case 'linux':
return 'Linux';
return conventions.os.downcasedAll ? 'linux' : 'Linux'
case 'darwin':
return 'macOS';
return conventions.os.renamedMacOS ? 'darwin' : 'macOS'
case 'win32':
return 'Windows';
return conventions.os.downcasedAll ? 'windows' : 'Windows'
default:
throw new Error(`${platform} is not supported`);
}

View File

@ -1,6 +1,7 @@
import * as core from '@actions/core';
import * as tc from '@actions/tool-cache';
import * as io from '@actions/io';
import getConventions from './get-conventions';
import getOS from './get-os';
import getArch from './get-arch';
import getURL from './get-url';
@ -47,10 +48,12 @@ export async function installer(version: string): Promise<void> {
const extended: string = core.getInput('extended');
core.debug(`Hugo extended: ${extended}`);
const osName: string = getOS(process.platform);
const conventions = getConventions(version);
const osName: string = getOS(process.platform, conventions);
core.debug(`Operating System: ${osName}`);
const archName: string = getArch(process.arch);
const archName: string = getArch(process.arch, osName, conventions);
core.debug(`Processor Architecture: ${archName}`);
const toolURL: string = getURL(osName, archName, extended, version);