Added Azure Func Tools Installer task. #11348

ajinkya599 · 2019-09-16T17:27:47Z

No description provided.

thesattiraju · 2019-09-25T07:21:55Z

Tasks/Common/func-tools-common/functoolsutility.ts

@@ -0,0 +1,79 @@
+"use strict";


Is there any other task using this common module? If not you can keep it within the task itself

Keeping it in Common, as we support installation as a part of main task itself for other tasks (Kubernetes, Helm etc), and if the customers ask for it we will be doing the same for this as well.

Tasks/Common/func-tools-common/functoolsutility.ts

thesattiraju · 2019-09-25T07:27:29Z

Tasks/Common/func-tools-common/functoolsutility.ts

+            cachedToolpath = await toolLib.cacheDir(unzippedFuncPath, funcToolName, version);
+            console.log(tl.loc("SuccessfullyDownloaded", version, cachedToolpath));
+        }
+        else {


Use a single styling format. else should go up

Tasks/Common/func-tools-common/functoolsutility.ts

thesattiraju · 2019-09-25T07:29:39Z

Tasks/FuncToolsInstallerV0/Strings/resources.resjson/en-US/resources.resjson

@@ -0,0 +1,16 @@
+{
+  "loc.friendlyName": "Install Azure Func Core Tools",
+  "loc.helpMarkDown": "[Learn more about this task](https://docs.microsoft.com/azure/devops/pipelines/tasks/tool/func-tools-installer)",


Use a redirection URL. like aka.ms/func-tools-installer

thesattiraju · 2019-09-25T07:32:21Z

Tasks/FuncToolsInstallerV0/package.json

+    "azure-pipelines-tool-lib": "0.12.0",
+    "func-tools-common": "file:../../_build/Tasks/Common/func-tools-common-1.0.0.tgz"
+  }
+}


Add in other meta-data to the package.json?

not doing as discussed.

thesattiraju · 2019-09-25T07:35:19Z

Tasks/FuncToolsInstallerV0/src/utils.ts

@@ -0,0 +1,31 @@
+"use strict";
+
+import tl = require('azure-pipelines-task-lib/task');


Use a single style here as well.
import * as tl from 'azure-pipelines-task-lib' You can refer to the task functions by referring to the module as well.

thesattiraju · 2019-09-25T07:37:44Z

Tasks/FuncToolsInstallerV0/src/functoolsinstaller.ts

+    const funcToolsPath = await utils.downloadFuncTools(version);
+
+    // prepend the tools path. instructs the agent to prepend for future tasks
+    if (!process.env['PATH'].startsWith(path.dirname(funcToolsPath))) {


Instead of startsWith shouldn't it be contains

No..in the task code we do which, and we want it to find this version of the tool. If a tool is present in multiple paths which resolves to the first entry. So contains may not work.

If there are multiple tools being installed in the same pipeline, the PATH var probably wouldn't have the func tool in the beginning.

Agreed. But this is the best we can do to ensure that the most recent installation (in the pipeline) is available for the tasks that follow. Hypothetical example:

Install func 1.0.0
Deploy function 1
Install func 2.0.0
Deploy function 2
Install func 1.0.0
Deploy function 3

In such a case, with contains check, Deploy function 3 would actually get func tool version 2.0.0 (since its prepended in the PATH after 1.0.0).

Agree that in above example, if third step was Install kubectl 1.0.0, prepending PATH in the 5th step would be redundant. Although one point to note is that the user is contributing to this redundancy.

Tasks/FuncToolsInstallerV0/task.json

Tasks/Common/func-tools-common/functoolsutility.ts

thesattiraju · 2019-10-21T15:16:48Z

Tasks/FuncToolsInstallerV0/src/utils.ts

+
+// handle user input scenerios
+function sanitizeVersionString(inputVersion: string) : string{
+    const version = toolLib.cleanVersion(inputVersion);


Would you like to add support to versions like v1 or 1.* or something like that later down the line?

Not planned as of now. I don't see a way we can achieve that.

thesattiraju · 2019-10-21T15:17:12Z

Tasks/FuncToolsInstallerV0/src/utils.ts

+
+export async function getFuncToolsVersion(): Promise<string> {
+    const version = tl.getInput("version");
+    if (version && version != "latest") {


thesattiraju · 2019-10-21T15:18:32Z

Tasks/FuncToolsInstallerV0/task.json

+    "instanceNameFormat": "Install func tools - $(version)",
+    "execution": {
+        "Node": {
+            "target": "src//functoolsinstaller.js"


/ would work

Changed to /

thesattiraju · 2019-10-21T15:19:59Z

Tasks/FuncToolsInstallerV0/task.json

+            "name": "version",
+            "label": "Version",
+            "type": "string",
+            "helpMarkDown": "Specify the version of Azure func tools to install. Ex:<br><br>2.7.1575<br>v2.7.1575<br>latest",


Have you tried using \n instead of <br>

No. <br> works fine.

thesattiraju · 2019-10-21T15:21:54Z

Tasks/Common/func-tools-common/functoolsutility.ts

+
+export async function getLatestFuncToolsVersion(): Promise<string> {
+    const funcToolsLatestReleaseUrl = 'https://api.github.com/repos/Azure/azure-functions-core-tools/releases/latest';
+    const stableFuncToolsVersion = '2.7.1585';


NIT: this can be moved outside the func

* Added Azure Func Tools Installer task. * Use toolLib cache to cache the installation. * remove unnecessary dependencies * Addressing PR review comments * PR review changes

ajinkya599 requested review from vithati and thesattiraju September 16, 2019 17:27

thesattiraju suggested changes Sep 25, 2019

View reviewed changes

ajinkya599 added 4 commits October 20, 2019 20:41

Added Azure Func Tools Installer task.

198518e

Use toolLib cache to cache the installation.

38c5a26

remove unnecessary dependencies

22ebd5e

Addressing PR review comments

f60afb5

ajinkya599 force-pushed the users/aj/funcToolInstaller branch from 82e7382 to f60afb5 Compare October 21, 2019 08:31

thesattiraju approved these changes Oct 21, 2019

View reviewed changes

ajinkya599 added 2 commits October 22, 2019 12:25

PR review changes

ad61648

Merge branch 'master' into users/aj/funcToolInstaller

4c8fae5

ajinkya599 merged commit 1e41470 into master Oct 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Azure Func Tools Installer task. #11348

Added Azure Func Tools Installer task. #11348

ajinkya599 commented Sep 16, 2019

thesattiraju Sep 25, 2019

ajinkya599 Oct 4, 2019

thesattiraju Sep 25, 2019

ajinkya599 Oct 21, 2019

thesattiraju Sep 25, 2019

ajinkya599 Oct 21, 2019

thesattiraju Sep 25, 2019

ajinkya599 Oct 21, 2019

thesattiraju Sep 25, 2019

ajinkya599 Oct 21, 2019

thesattiraju Sep 25, 2019

ajinkya599 Oct 6, 2019

thesattiraju Oct 21, 2019

ajinkya599 Oct 21, 2019

thesattiraju Oct 21, 2019

ajinkya599 Oct 21, 2019

thesattiraju Oct 21, 2019

ajinkya599 Oct 22, 2019

thesattiraju Oct 21, 2019

ajinkya599 Oct 22, 2019

thesattiraju Oct 21, 2019

ajinkya599 Oct 21, 2019

thesattiraju Oct 21, 2019

ajinkya599 Oct 22, 2019

		@@ -0,0 +1,31 @@
		"use strict";

		import tl = require('azure-pipelines-task-lib/task');

Added Azure Func Tools Installer task. #11348

Added Azure Func Tools Installer task. #11348

Conversation

ajinkya599 commented Sep 16, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment