[FEATURE] Add --framework-version option (#306)

Co-authored-by: Merlin Beutlberger <[email protected]>

Author: matz3

lib/cli/commands/build.js

@@ -59,6 +59,10 @@ build.builder = function(cli) {
 			describe: "A list of specific tasks to be excluded from default/dev set",
 			type: "array"
 		})
+		.option("framework-version", {
+			describe: "Overrides the framework version defined by the project",
+			type: "string"
+		})
 		.example("ui5 build --all", "Preload build for project and dependencies to \"./dist\"")
 		.example("ui5 build --all --exclude-task=* --include-task=createDebugFiles generateAppPreload",
 			"Build project and dependencies but only apply the createDebugFiles- and generateAppPreload tasks")
@@ -78,10 +82,18 @@ async function handleBuild(argv) {
 	const command = argv._[argv._.length - 1];
 	logger.setShowProgress(true);
 
-	const tree = await normalizer.generateProjectTree({
+	const normalizerOptions = {
 		translatorName: argv.translator,
 		configPath: argv.config
-	});
+	};
+
+	if (argv.frameworkVersion) {
+		normalizerOptions.frameworkOptions = {
+			versionOverride: argv.frameworkVersion
+		};
+	}
+
+	const tree = await normalizer.generateProjectTree(normalizerOptions);
 	await builder.build({
 		tree: tree,
 		destPath: argv.dest,

lib/cli/commands/serve.js

@@ -50,6 +50,10 @@ serve.builder = function(cli) {
 			default: false,
 			type: "boolean"
 		})
+		.option("framework-version", {
+			describe: "Overrides the framework version defined by the project",
+			type: "string"
+		})
 		.example("ui5 serve", "Start a web server for the current project")
 		.example("ui5 serve --h2", "Enable the HTTP/2 protocol for the web server (requires SSL certificate)")
 		.example("ui5 serve --config /path/to/ui5.yaml", "Use the project configuration from a custom path")
@@ -64,10 +68,18 @@ serve.handler = async function(argv) {
 	const ui5Server = require("@ui5/server");
 	const server = ui5Server.server;
 
-	const tree = await normalizer.generateProjectTree({
+	const normalizerOptions = {
 		translatorName: argv.translator,
 		configPath: argv.config
-	});
+	};
+
+	if (argv.frameworkVersion) {
+		normalizerOptions.frameworkOptions = {
+			versionOverride: argv.frameworkVersion
+		};
+	}
+
+	const tree = await normalizer.generateProjectTree(normalizerOptions);
 	let port = argv.port;
 	let changePortIfInUse = false;
 

lib/cli/commands/tree.js

@@ -22,6 +22,16 @@ tree.builder = function(cli) {
 			default: false,
 			type: "boolean"
 		})
+		.option("framework-version", {
+			describe: "Overrides the framework version defined by the project. Only supported in combination with --full",
+			type: "string"
+		}).check((argv) => {
+			if (argv.frameworkVersion && !argv.full) {
+				throw new Error(`"framework-version" can only be used in combination with option "--full"`);
+			} else {
+				return true;
+			}
+		})
 		.example("ui5 tree > tree.txt", "Pipes the dependency tree into a new file \"tree.txt\"")
 		.example("ui5 tree --json > tree.json", "Pipes the dependency tree into a new file \"tree.json\"");
 };
@@ -37,6 +47,13 @@ tree.handler = async function(argv) {
 		},
 		configPath: argv.config
 	};
+
+	if (argv.frameworkVersion ) {
+		options.frameworkOptions = {
+			versionOverride: argv.frameworkVersion
+		};
+	}
+
 	let projectTree;
 	if (argv.full) {
 		projectTree = await normalizer.generateProjectTree(options);

test/lib/cli/commands/build.js

@@ -100,3 +100,26 @@ test.serial("ui5 build jsdoc", async (t) => {
 		"JSDoc build called with expected arguments"
 	);
 });
+
+test.serial("ui5 build --framework-version 1.99", async (t) => {
+	normalizerStub.resolves({
+		metadata:
+		{
+			name: "Sample"
+		}
+	});
+
+	args._ = ["build"];
+	args.frameworkVersion = "1.99.0";
+	await build.handler(args);
+	t.deepEqual(
+		normalizerStub.getCall(0).args[0],
+		{
+			configPath: undefined,
+			translatorName: "npm",
+			frameworkOptions: {
+				versionOverride: "1.99.0"
+			}
+		}, "generateProjectTree got called with expected arguments"
+	);
+});

test/lib/cli/commands/serve.js

@@ -320,3 +320,26 @@ test.serial("ui5 serve --h2 with ui5.yaml port setting and port CLI argument", a
 	t.deepEqual(injectedServerConfig.port, 5555, "https port setting from CLI argument was used");
 	t.deepEqual(injectedServerConfig.changePortIfInUse, false, "changePortIfInUse is set to false");
 });
+
+test.serial("ui5 serve: --framework-version", async (t) => {
+	normalizerStub.resolves(projectTree);
+	serverStub.resolves({h2: false, port: 8080});
+
+	// loads project tree
+	const pPrepareServerConfig = await serve.handler(
+		Object.assign({}, defaultInitialHandlerArgs, {frameworkVersion: "1.2.3"})
+	);
+	// preprocess project config, skipping cert load
+	const pServeServer = await pPrepareServerConfig;
+	// serve server using config
+	await pServeServer;
+
+	t.is(normalizerStub.called, true);
+	t.deepEqual(normalizerStub.getCall(0).args, [{
+		configPath: undefined,
+		translatorName: "npm",
+		frameworkOptions: {
+			versionOverride: "1.2.3"
+		}
+	}]);
+});

test/lib/cli/commands/tree.js

@@ -74,6 +74,22 @@ test.serial("ui5 tree --dedupe=true", async (t) => {
 	}), true, "includeDeduped passed as expected");
 });
 
+test.serial("ui5 tree --full --framework-version", async (t) => {
+	normalizer.generateProjectTree.resolves({});
+	await tree.handler({full: true, frameworkVersion: "1.2.3"});
+	t.is(normalizer.generateProjectTree.called, true, "project tree output");
+	t.deepEqual(normalizer.generateProjectTree.getCall(0).args, [{
+		configPath: undefined,
+		translatorName: undefined,
+		translatorOptions: {
+			includeDeduped: true
+		},
+		frameworkOptions: {
+			versionOverride: "1.2.3"
+		}
+	}]);
+});
+
 // test.serial("Error: throws on error during processing", async (t) => {
 // 	normalizer.generateDependencyTree.rejects(new Error("Some error happened ..."));
 // 	const processExitStub = sinon.stub(process, "exit");