Skip to content

Commit

Permalink
feat(core): add params to the postPackage hook (#1896)
Browse files Browse the repository at this point in the history 
* refactor(test): make a helper function for updating an app's package.json
  • Loading branch information
@malept
malept authored Aug 11, 2020
1 parent a311e32 commit e9a2ba0
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 43 deletions.
9 changes: 7 additions & 2 deletions packages/api/core/src/api/package.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,9 +205,14 @@ export default async ({

d('packaging with options', packageOpts);

await packager(packageOpts);
const outputPaths = await packager(packageOpts);

await runHook(forgeConfig, 'postPackage');
await runHook(forgeConfig, 'postPackage', {
arch,
outputPaths,
platform,
spinner: packagerSpinner,
});

if (packagerSpinner) packagerSpinner!.succeed();
};
93 changes: 52 additions & 41 deletions packages/api/core/test/slow/api_spec_slow.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ const forge = proxyquire.noCallThru().load('../../src/api', {
'./install': async () => {},
}).api;

type PackageJSON = Record<string, any>;

async function updatePackageJSON(
dir: string,
packageJSONUpdater: (packageJSON: PackageJSON) => Promise<void>,
) {
const packageJSON = await readRawPackageJson(dir);
await packageJSONUpdater(packageJSON);
await fs.writeJson(path.resolve(dir, 'package.json'), packageJSON);
}

for (const nodeInstaller of ['npm', 'yarn']) {
process.env.NODE_INSTALLER = nodeInstaller;
describe(`electron-forge API (with installer=${nodeInstaller})`, () => {
Expand Down Expand Up @@ -137,11 +148,11 @@ for (const nodeInstaller of ['npm', 'yarn']) {
});

it('creates a forge config', async () => {
const packageJSON = await readRawPackageJson(dir);
packageJSON.name = 'Name';
packageJSON.productName = 'Product Name';
packageJSON.customProp = 'propVal';
await fs.writeJson(path.resolve(dir, 'package.json'), packageJSON);
await updatePackageJSON(dir, async (packageJSON) => {
packageJSON.name = 'Name';
packageJSON.productName = 'Product Name';
packageJSON.customProp = 'propVal';
});

await forge.import({ dir });

Expand Down Expand Up @@ -181,36 +192,36 @@ describe('Electron Forge API', () => {
dir = path.join(await ensureTestDirIsNonexistent(), 'electron-forge-test');
await forge.init({ dir });

const packageJSON = await readRawPackageJson(dir);
packageJSON.name = 'testapp';
packageJSON.version = '1.0.0-beta.1';
packageJSON.productName = 'Test-App';
packageJSON.config.forge.packagerConfig.asar = false;
if (process.platform === 'win32') {
await fs.copy(
path.join(__dirname, '..', 'fixture', 'bogus-private-key.pvk'),
path.join(dir, 'default.pvk'),
);
devCert = await createDefaultCertificate(
'CN=Test Author',
{ certFilePath: dir },
);
} else if (process.platform === 'linux') {
packageJSON.config.forge.packagerConfig.executableName = 'testapp';
}
packageJSON.homepage = 'http://www.example.com/';
packageJSON.author = 'Test Author';
await fs.writeJson(path.resolve(dir, 'package.json'), packageJSON);
await updatePackageJSON(dir, async (packageJSON) => {
packageJSON.name = 'testapp';
packageJSON.version = '1.0.0-beta.1';
packageJSON.productName = 'Test-App';
packageJSON.config.forge.packagerConfig.asar = false;
if (process.platform === 'win32') {
await fs.copy(
path.join(__dirname, '..', 'fixture', 'bogus-private-key.pvk'),
path.join(dir, 'default.pvk'),
);
devCert = await createDefaultCertificate(
'CN=Test Author',
{ certFilePath: dir },
);
} else if (process.platform === 'linux') {
packageJSON.config.forge.packagerConfig.executableName = 'testapp';
}
packageJSON.homepage = 'http://www.example.com/';
packageJSON.author = 'Test Author';
});
});

it('throws an error when all is set', async () => {
let packageJSON = await readRawPackageJson(dir);
packageJSON.config.forge.packagerConfig.all = true;
await fs.writeJson(path.join(dir, 'package.json'), packageJSON);
await updatePackageJSON(dir, async (packageJSON) => {
packageJSON.config.forge.packagerConfig.all = true;
});
await expect(forge.package({ dir })).to.eventually.be.rejectedWith(/packagerConfig\.all is not supported by Electron Forge/);
packageJSON = await readRawPackageJson(dir);
delete packageJSON.config.forge.packagerConfig.all;
await fs.writeJson(path.join(dir, 'package.json'), packageJSON);
await updatePackageJSON(dir, async (packageJSON) => {
delete packageJSON.config.forge.packagerConfig.all;
});
});

it('can package to outDir without errors', async () => {
Expand All @@ -224,9 +235,9 @@ describe('Electron Forge API', () => {
});

it('can make from custom outDir without errors', async () => {
const packageJSON = await readRawPackageJson(dir);
packageJSON.config.forge.makers = [{ name: require.resolve('@electron-forge/maker-zip') }];
await fs.writeJson(path.resolve(dir, 'package.json'), packageJSON);
await updatePackageJSON(dir, async (packageJSON) => {
packageJSON.config.forge.makers = [{ name: require.resolve('@electron-forge/maker-zip') }];
});

await forge.make({ dir, skipPackage: true, outDir: `${dir}/foo` });

Expand All @@ -242,10 +253,10 @@ describe('Electron Forge API', () => {
});

it('can package without errors', async () => {
const packageJSON = await readRawPackageJson(dir);
delete packageJSON.dependencies['ref-napi'];
packageJSON.config.forge.packagerConfig.asar = true;
await fs.writeJson(path.resolve(dir, 'package.json'), packageJSON);
await updatePackageJSON(dir, async (packageJSON) => {
delete packageJSON.dependencies['ref-napi'];
packageJSON.config.forge.packagerConfig.asar = true;
});

await forge.package({ dir });
});
Expand Down Expand Up @@ -315,9 +326,9 @@ describe('Electron Forge API', () => {
) {
describe(`make (with target=${path.basename(path.dirname(target().name))})`, async () => {
before(async () => {
const packageJSON = await readRawPackageJson(dir);
packageJSON.config.forge.makers = [target()];
await fs.writeFile(path.resolve(dir, 'package.json'), JSON.stringify(packageJSON));
await updatePackageJSON(dir, async (packageJSON) => {
packageJSON.config.forge.makers = [target()];
});
});

for (const optionsFetcher of options) {
Expand Down

0 comments on commit e9a2ba0

Please sign in to comment.