executeJsdocSdkTransformation: Skip projects with missing api.json

Prominent example: theme libraries
SAP · Mar 14, 2019 · 7d3e696 · 7d3e696
1 parent 480b832
commit 7d3e696
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 8 deletions.
diff --git a/lib/tasks/jsdoc/executeJsdocSdkTransformation.js b/lib/tasks/jsdoc/executeJsdocSdkTransformation.js
@@ -1,3 +1,4 @@
+const log = require("@ui5/logger").getLogger("builder:tasks:executeJsdocSdkTransformation");
 const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
 const fsInterface = require("@ui5/fs").fsInterface;
 const sdkTransformer = require("../../processors/jsdoc/sdkTransformer");
@@ -28,8 +29,9 @@ const executeJsdocSdkTransformation = async function({workspace, dependencies, o
  dependencies.byGlob("/test-resources/**/designtime/api.json")
  ]);
  if (!apiJsons.length) {
- throw new Error(`[executeJsdocSdkTransformation]: Failed to locate api.json resource for project ` +
- `${options.projectName}.`);
+ log.info(`Failed to locate api.json resource for project ${options.projectName}. ` +
+ `Skipping SDK Transformation...`);
+ return;
  } else if (apiJsons.length > 1) {
  throw new Error(`[executeJsdocSdkTransformation]: Found more than one api.json resources for project ` +
  `${options.projectName}.`);

diff --git a/test/lib/tasks/jsdoc/executeJsdocSdkTransformation.js b/test/lib/tasks/jsdoc/executeJsdocSdkTransformation.js
@@ -89,6 +89,9 @@ test.serial("executeJsdocSdkTransformation", async (t) => {
  t.deepEqual(writeStub.getCall(1).args[0], "resource B", "Write got called with correct arguments");
 
  mock.stop("../../../../lib/processors/jsdoc/sdkTransformer");
+
+ sinon.restore();
+ mock.reRequire("../../../../lib/tasks/jsdoc/executeJsdocSdkTransformation");
 });
 
 test("executeJsdocSdkTransformation with missing parameters", async (t) => {
@@ -97,7 +100,15 @@ test("executeJsdocSdkTransformation with missing parameters", async (t) => {
  "Correct error message thrown");
 });
 
-test("executeJsdocSdkTransformation with missing project api.json", async (t) => {
+test.serial("executeJsdocSdkTransformation with missing project api.json (skips processing)", async (t) => {
+ const logger = require("@ui5/logger");
+ const infoLogStub = sinon.stub();
+ const myLoggerInstance = {
+ info: infoLogStub
+ };
+ sinon.stub(logger, "getLogger").returns(myLoggerInstance);
+ const executeJsdocSdkTransformation = mock.reRequire("../../../../lib/tasks/jsdoc/executeJsdocSdkTransformation");
+
  const byGlobWorkspaceStub = sinon.stub()
  .onFirstCall().resolves([])
  .onSecondCall().resolves([{
@@ -116,17 +127,22 @@ test("executeJsdocSdkTransformation with missing project api.json", async (t) =>
  byGlob: byGlobDependenciesStub
  };
 
- const error = await t.throws(executeJsdocSdkTransformation({
+ await executeJsdocSdkTransformation({
  workspace,
  dependencies,
  options: {
  projectName: "some.project",
  dotLibraryPattern: "some .library pattern"
  }
- }));
- t.deepEqual(error.message,
- "[executeJsdocSdkTransformation]: Failed to locate api.json resource for project some.project.",
- "Correct error message thrown");
+ });
+
+ t.deepEqual(infoLogStub.callCount, 1, "One message has been logged");
+ t.deepEqual(infoLogStub.getCall(0).args[0],
+ "Failed to locate api.json resource for project some.project. Skipping SDK Transformation...",
+ "Correct message has been logged");
+
+ sinon.restore();
+ mock.reRequire("../../../../lib/tasks/jsdoc/executeJsdocSdkTransformation");
 });
 
 test("executeJsdocSdkTransformation too many project api.json resources", async (t) => {