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

[FIX] generateManifestBundle: Only glob files from project namespace #267

Merged
merged 2 commits into from
Jun 24, 2019
Merged

[FIX] generateManifestBundle: Only glob files from project namespace #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5085e50
[FIX] generateManifestBundle: Only glob files from project namespace
RandomByte Jun 18, 2019
b8b1892
[INTERNAL] manifestBundler: Do not bundle resources not based on name…
RandomByte Jun 19, 2019
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
12 changes: 9 additions & 3 deletions lib/processors/bundlers/manifestBundler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
const path = require("path");
const yazl = require("yazl");
const resourceFactory = require("@ui5/fs").resourceFactory;
const log = require("@ui5/logger").getLogger("builder:processors:bundlers:manifestBundler");

/**
* Repository to handle i18n resource files
Expand Down Expand Up @@ -99,10 +100,15 @@ module.exports = ({resources, options}) => {
return archiveContent;
}).then((archiveContent) => new Promise((resolve) => {
const zip = new yazl.ZipFile();
const regex = new RegExp(`^/resources/${options.namespace}/`);
const rBasePath = new RegExp(`^/resources/${options.namespace}/`);
archiveContent.forEach((content, path) => {
// Root-project only: Remove namespace prefix if given
const normalizedPath = path.replace(regex, "");
if (!rBasePath.test(path)) {
log.verbose(`Not bundling resource with path ${path} since it is not based on path ` +
`/resources/${options.namespace}/`);
return;
}
// Remove base path. Absolute paths are not allowed in ZIP files
const normalizedPath = path.replace(rBasePath, "");
zip.addBuffer(content, normalizedPath);
});
zip.end();
Expand Down
46 changes: 25 additions & 21 deletions lib/tasks/bundlers/generateManifestBundle.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,29 @@ const BUNDLE_NAME = "manifest-bundle.zip";
* @param {string} parameters.options.namespace Namespace of the application/library
* @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
*/
module.exports = function({workspace, options}) {
return workspace.byGlob(`/**/{${DESCRIPTOR},*${PROPERTIES_EXT}}`)
.then((allResources) => {
if (allResources.length > 0) {
return manifestBundler({
resources: allResources,
options: {
descriptor: DESCRIPTOR,
propertiesExtension: PROPERTIES_EXT,
bundleName: BUNDLE_NAME,
namespace: options.namespace
}
}).then((processedResources) => {
return Promise.all(processedResources.map((resource) => {
return workspace.write(resource);
}));
});
} else {
log.verbose(`Could not find a "${DESCRIPTOR}" file for project ${options.projectName}, creation of "${BUNDLE_NAME}" is skipped!`);
}
});
module.exports = async function({workspace, options}) {
if (!options || !options.projectName || !options.namespace) {
throw new Error("[generateManifestBundle]: One or more mandatory options not provided");
}

const allResources = await workspace.byGlob(`/resources/${options.namespace}/**/{${DESCRIPTOR},*${PROPERTIES_EXT}}`);
if (allResources.length === 0) {
log.verbose(`Could not find a "${DESCRIPTOR}" file for project ${options.projectName}, ` +
`creation of "${BUNDLE_NAME}" is skipped!`);
return;
}

const processedResources = await manifestBundler({
resources: allResources,
options: {
descriptor: DESCRIPTOR,
propertiesExtension: PROPERTIES_EXT,
bundleName: BUNDLE_NAME,
namespace: options.namespace
}
});

await Promise.all(processedResources.map((resource) => {
return workspace.write(resource);
}));
};
2 changes: 1 addition & 1 deletion lib/types/library/LibraryBuilder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ class LibraryBuilder extends AbstractBuilder {
return generateManifestBundle({
workspace: resourceCollections.workspace,
options: {
projectType: project.type,
projectName: project.metadata.name,
namespace: project.metadata.namespace
}
});
Expand Down
208 changes: 93 additions & 115 deletions test/lib/tasks/bundlers/generateManifestBundle.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,105 @@
const test = require("ava");
const path = require("path");
const sinon = require("sinon");
const mock = require("mock-require");

const chai = require("chai");
chai.use(require("chai-fs"));
const assert = chai.assert;

const {promisify} = require("util");
const extractZip = promisify(require("extract-zip"));
const recursive = require("recursive-readdir");

const ui5Builder = require("../../../../");
const builder = ui5Builder.builder;
const generateManifestBundle = require("../../../../lib/tasks/bundlers/generateManifestBundle");

test.serial("generateManifestBundle", async (t) => {
const byGlobStub = sinon.stub().resolves(["some resource", "some other resource"]);
const writeStub = sinon.stub().resolves();
const workspace = {
byGlob: byGlobStub,
write: writeStub
};

const manifestBundlerStub = sinon.stub().resolves(["some new resource", "some other new resource"]);
mock("../../../../lib/processors/bundlers/manifestBundler", manifestBundlerStub);
const generateManifestBundle = mock.reRequire("../../../../lib/tasks/bundlers/generateManifestBundle");


await generateManifestBundle({
workspace,
options: {
projectName: "some project",
namespace: "some/project"
}
});
t.deepEqual(byGlobStub.callCount, 1, "workspace.byGlob got called once");
t.deepEqual(byGlobStub.getCall(0).args[0], "/resources/some/project/**/{manifest.json,*.properties}",
"workspace.byGlob got called with the correct arguments");

t.deepEqual(manifestBundlerStub.callCount, 1, "manifestBundler got called once");
t.deepEqual(manifestBundlerStub.getCall(0).args[0], {
resources: ["some resource", "some other resource"],
options: {
descriptor: "manifest.json",
propertiesExtension: ".properties",
bundleName: "manifest-bundle.zip",
namespace: "some/project"
}
}, "manifestBundler got called with the correct arguments");

t.deepEqual(writeStub.callCount, 2, "workspace.write got called twice");
t.deepEqual(writeStub.getCall(0).args[0], "some new resource",
"workspace.write got called with the correct arguments");
t.deepEqual(writeStub.getCall(1).args[0], "some other new resource",
"workspace.write got called with the correct arguments");

mock.stop("../../../../lib/processors/bundlers/manifestBundler");
});

test.serial("generateManifestBundle with no resources", async (t) => {
const byGlobStub = sinon.stub().resolves([]);
const workspace = {
byGlob: byGlobStub
};

const manifestBundlerStub = sinon.stub().resolves([]);
mock("../../../../lib/processors/bundlers/manifestBundler", manifestBundlerStub);
const generateManifestBundle = mock.reRequire("../../../../lib/tasks/bundlers/generateManifestBundle");


await generateManifestBundle({
workspace,
options: {
projectName: "some project",
namespace: "some/project"
}
});
t.deepEqual(byGlobStub.callCount, 1, "workspace.byGlob got called once");
t.deepEqual(byGlobStub.getCall(0).args[0], "/resources/some/project/**/{manifest.json,*.properties}",
"workspace.byGlob got called with the correct arguments");

t.deepEqual(manifestBundlerStub.callCount, 0, "manifestBundler not called");

mock.stop("../../../../lib/processors/bundlers/manifestBundler");
});

test("generateManifestBundle with missing parameters", async (t) => {
const error = await t.throwsAsync(generateManifestBundle({}));
t.deepEqual(error.message, "[generateManifestBundle]: One or more mandatory options not provided",
"Rejected with correct error message");
});


/* ===================
Integration Tests
*/

const applicationBPath = path.join(__dirname, "..", "..", "..", "fixtures", "application.b");
const libraryCore = path.join(__dirname, "..", "..", "..", "fixtures", "sap.ui.core-evo");
const libraryKPath = path.join(__dirname, "..", "..", "..", "fixtures", "library.k");
const {promisify} = require("util");
const extractZip = promisify(require("extract-zip"));

const recursive = require("recursive-readdir");

const findFiles = (folder) => {
return new Promise((resolve, reject) => {
Expand Down Expand Up @@ -91,113 +177,7 @@ const applicationBTree = {
"id": "application.b",
"version": "1.0.0",
"path": applicationBPath,
"dependencies": [
{
"id": "library.d",
"version": "1.0.0",
"path": path.join(applicationBPath, "..", "library.d"),
"dependencies": [],
"_level": 1,
"specVersion": "0.1",
"type": "library",
"metadata": {
"name": "library.d",
"namespace": "library/d",
"copyright": "Some fancy copyright"
},
"resources": {
"configuration": {
"paths": {
"src": "main/src",
"test": "main/test"
}
},
"pathMappings": {
"/resources/": "main/src",
"/test-resources/": "main/test"
}
}
},
{
"id": "library.a",
"version": "1.0.0",
"path": path.join(applicationBPath, "..", "collection", "library.a"),
"dependencies": [],
"_level": 1,
"specVersion": "0.1",
"type": "library",
"metadata": {
"name": "library.a",
"namespace": "library/a",
"copyright": "${copyright}"
},
"resources": {
"configuration": {
"paths": {
"src": "src",
"test": "test"
}
},
"pathMappings": {
"/resources/": "src",
"/test-resources/": "test"
}
}
},
{
"id": "library.b",
"version": "1.0.0",
"path": path.join(applicationBPath, "..", "collection", "library.b"),
"dependencies": [],
"_level": 1,
"specVersion": "0.1",
"type": "library",
"metadata": {
"name": "library.b",
"namespace": "library/b",
"copyright": "${copyright}"
},
"resources": {
"configuration": {
"paths": {
"src": "src",
"test": "test"
}
},
"pathMappings": {
"/resources/": "src",
"/test-resources/": "test"
}
}
},
{
"id": "library.c",
"version": "1.0.0",
"path": path.join(applicationBPath, "..", "collection", "library.c"),
"dependencies": [],
"_level": 1,
"specVersion": "0.1",
"type": "library",
"metadata": {
"name": "library.c",
"namespace": "library/c",
"copyright": "${copyright}"
},
"resources": {
"configuration": {
"paths": {
"src": "src",
"test": "test"
}
},
"pathMappings": {
"/resources/": "src",
"/test-resources/": "test"
}
}
}
],
"builder": {},
"dependencies": [],
"_level": 0,
"specVersion": "0.1",
"type": "application",
Expand Down Expand Up @@ -232,8 +212,7 @@ const libraryKTree = {
"type": "library",
"metadata": {
"name": "sap.ui.core",
"namespace": "sap/ui/core",
"copyright": "Some fancy copyright"
"namespace": "sap/ui/core"
},
"resources": {
"configuration": {
Expand All @@ -252,8 +231,7 @@ const libraryKTree = {
"type": "library",
"metadata": {
"name": "library.k",
"namespace": "library/k",
"copyright": "UI development toolkit for HTML5 (OpenUI5)\n * (c) Copyright 2009-xxx SAP SE or an SAP affiliate company.\n * Licensed under the Apache License, Version 2.0 - see LICENSE.txt."
"namespace": "library/k"
},
"resources": {
"configuration": {
Expand Down