Add support for npm and yarn (#25)

Author: markphip

src/artifacts-helper/NOTES.md

@@ -1,7 +1,21 @@
 This installs [Azure Artifacts Credential Provider](https://github.com/microsoft/artifacts-credprovider)
-and optionally configures an alias for `dotnet` and `nuget` that dynamically sets an authentication token
+and optionally configures an alias for `dotnet`, `nuget`, `npm`, and `yarn` that dynamically sets an authentication token
 for pulling artifacts from a feed before running the command.
 
+For `npm` and `yarn` this requires that your `~/.npmrc` file is configured to use the ${ARTIFACTS_ACCESSTOKEN}
+environment variable for the password. A helper script has been added that you can use to write your `~/.npmrc`
+file during your setup process, though there are many ways you could accomplish this. To use the script, run it like
+this:
+
+```
+write-npm.sh pkgs.dev.azure.com/orgname/projectname/_packaging/feed1/npm
+write-npm.sh pkgs.dev.azure.com/orgname/projectname/_packaging/feed2/npm username
+write-npm.sh pkgs.dev.azure.com/orgname/projectname/_packaging/feed3/npm username email
+```
+
+You must pass the feed name to the script, but you can optionally provide a username and email if desired. Defaults
+are put in place if they are not provided.
+
 ## OS Support
 
 This feature is tested to work on Debian/Ubuntu and Mariner CBL 2.0

src/artifacts-helper/devcontainer-feature.json

@@ -1,7 +1,7 @@
 {
     "name": "Azure Artifacts Credential Helper",
     "id": "artifacts-helper",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "Configures Codespace to authenticate with Azure Artifact feeds",
     "options": {
         "nugetURIPrefixes": {
@@ -23,6 +23,16 @@
             "type": "boolean",
             "default": true,
             "description": "Create alias for nuget"
+        },
+        "npmAlias": {
+            "type": "boolean",
+            "default": true,
+            "description": "Create alias for npm"
+        },
+        "yarnAlias": {
+            "type": "boolean",
+            "default": true,
+            "description": "Create alias for yarn"
         }
     },
     "installsAfter": [

src/artifacts-helper/install.sh

@@ -6,6 +6,8 @@ PREFIXES="${NUGETURIPREFIXES:-"https://pkgs.dev.azure.com/"}"
 USENET6="${DOTNET6:-"false"}"
 ALIAS_DOTNET="${DOTNETALIAS:-"true"}"
 ALIAS_NUGET="${NUGETALIAS:-"true"}"
+ALIAS_NPM="${NPMALIAS:-"true"}"
+ALIAS_YARN="${YARNALIAS:-"true"}"
 
 # Source /etc/os-release to get OS info
 . /etc/os-release
@@ -51,6 +53,13 @@ sed "s|REPLACE_WITH_AZURE_DEVOPS_NUGET_FEED_URL_PREFIX|${PREFIXES}|g" ./scripts/
 chmod +rx /usr/local/bin/run-dotnet.sh
 sed "s|REPLACE_WITH_AZURE_DEVOPS_NUGET_FEED_URL_PREFIX|${PREFIXES}|g" ./scripts/run-nuget.sh > /usr/local/bin/run-nuget.sh
 chmod +rx /usr/local/bin/run-nuget.sh
+cp ./scripts/run-npm.sh /usr/local/bin/run-npm.sh
+chmod +rx /usr/local/bin/run-npm.sh
+cp ./scripts/run-yarn.sh /usr/local/bin/run-yarn.sh
+chmod +rx /usr/local/bin/run-yarn.sh
+cp ./scripts/write-npm.sh /usr/local/bin/write-npm.sh
+chmod +rx /usr/local/bin/write-npm.sh
+
 
 if command -v sudo >/dev/null 2>&1; then
     if [ "root" != "$_REMOTE_USER" ]; then
@@ -62,6 +71,14 @@ if command -v sudo >/dev/null 2>&1; then
             sudo -u ${_REMOTE_USER} bash -c "echo 'alias nuget=/usr/local/bin/run-nuget.sh' >> ~/.bashrc"
             sudo -u ${_REMOTE_USER} bash -c "echo 'alias nuget=/usr/local/bin/run-nuget.sh' >> ~/.zshrc"
         fi
+        if [ "${ALIAS_NPM}" = "true" ]; then
+            sudo -u ${_REMOTE_USER} bash -c "echo 'alias npm=/usr/local/bin/run-npm.sh' >> ~/.bashrc"
+            sudo -u ${_REMOTE_USER} bash -c "echo 'alias npm=/usr/local/bin/run-npm.sh' >> ~/.zshrc"
+        fi
+        if [ "${ALIAS_YARN}" = "true" ]; then
+            sudo -u ${_REMOTE_USER} bash -c "echo 'alias yarn=/usr/local/bin/run-yarn.sh' >> ~/.bashrc"
+            sudo -u ${_REMOTE_USER} bash -c "echo 'alias yarn=/usr/local/bin/run-yarn.sh' >> ~/.zshrc"
+        fi        
         sudo -u ${_REMOTE_USER} bash -c "/tmp/install-provider.sh ${USENET6}"
         rm /tmp/install-provider.sh
         exit 0
@@ -78,6 +95,16 @@ if [ "${ALIAS_NUGET}" = "true" ]; then
     echo "alias nuget='/usr/local/bin/run-nuget.sh'" >> /etc/zsh/zshrc || true
 fi
 
+if [ "${ALIAS_NPM}" = "true" ]; then
+    sudo -u ${_REMOTE_USER} bash -c "echo 'alias npm=/usr/local/bin/run-npm.sh' >> /etc/bash.bashrc || true
+    sudo -u ${_REMOTE_USER} bash -c "echo 'alias npm=/usr/local/bin/run-npm.sh' >> /etc/zsh/zshrc || true
+fi
+
+if [ "${ALIAS_YARN}" = "true" ]; then
+    sudo -u ${_REMOTE_USER} bash -c "echo 'alias yarn=/usr/local/bin/run-yarn.sh' >> /etc/bash.bashrc || true
+    sudo -u ${_REMOTE_USER} bash -c "echo 'alias yarn=/usr/local/bin/run-yarn.sh' >> /etc/zsh/zshrc || true
+fi
+
 rm /tmp/install-provider.sh
 
 exit 0

src/artifacts-helper/scripts/run-npm.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+if [ -f "${HOME}/ado-auth-helper" ]; then
+  export ARTIFACTS_ACCESSTOKEN=$(${HOME}/ado-auth-helper get-access-token)
+fi
+
+# Find the npm executable so we do not run the bash alias again
+NPM_EXE=$(which npm)
+
+${NPM_EXE} "$@"
+EXIT_CODE=$?
+unset NPM_EXE
+
+if [ -f "${HOME}/ado-auth-helper" ]; then
+    unset ARTIFACTS_ACCESSTOKEN
+fi
+
+exit $EXIT_CODE

src/artifacts-helper/scripts/run-yarn.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+if [ -f "${HOME}/ado-auth-helper" ]; then
+  export ARTIFACTS_ACCESSTOKEN=$(${HOME}/ado-auth-helper get-access-token)
+fi
+
+# Find the yarn executable so we do not run the bash alias again
+YARN_EXE=$(which yarn)
+
+${YARN_EXE} "$@"
+EXIT_CODE=$?
+unset YARN_EXE
+
+if [ -f "${HOME}/ado-auth-helper" ]; then
+    unset ARTIFACTS_ACCESSTOKEN
+fi
+
+exit $EXIT_CODE

src/artifacts-helper/scripts/write-npm.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+ARTIFACTS_FEED=${1:-"required"}
+FEED_USER="${2:-"codespaces"}"
+FEED_EMAIL="${3:-"codespaces@github.com"}"
+
+# If ARTIFACTS_FEED equals "required" then exit with error message
+if [ "${ARTIFACTS_FEED}" = "required" ]; then
+    echo "  Usage: write-npm.sh <ARTIFACTS_FEED> <FEED_USER>(optional) <FEED_EMAIL>(optional)"
+    echo "example: write-npm.sh pkgs.dev.azure.com/orgname/projectname/_packaging/feedname/npm"
+    exit 1
+fi
+
+echo "//${ARTIFACTS_FEED}/registry/:username=${FEED_USER}" >> ${HOME}/.npmrc
+echo "//${ARTIFACTS_FEED}/registry/:_password=\${ARTIFACTS_ACCESSTOKEN}" >> ${HOME}/.npmrc
+echo "//${ARTIFACTS_FEED}/registry/:email=${FEED_EMAIL}" >> ${HOME}/.npmrc
+echo "//${ARTIFACTS_FEED}/:username=${FEED_USER}"  >> ${HOME}/.npmrc
+echo "//${ARTIFACTS_FEED}/:_password=\${ARTIFACTS_ACCESSTOKEN}" >> ${HOME}/.npmrc
+echo "//${ARTIFACTS_FEED}/:email=${FEED_EMAIL}" >> ${HOME}/.npmrc

test/artifacts-helper/test.sh

@@ -8,6 +8,8 @@ source dev-container-features-test-lib
 # Feature-specific tests
 check "dotnet" grep "pkgs.dev.azure.com" <(cat /usr/local/bin/run-dotnet.sh)
 check "nuget" grep "pkgs.dev.azure.com" <(cat /usr/local/bin/run-nuget.sh)
+check "write-npm" /usr/local/bin/write-npm.sh pkgs.dev.azure.com && grep "pkgs.dev.azure.com" <(cat ~/.npmrc)
+
 
 # Report results
 # If any of the checks above exited with a non-zero exit code, the test will fail.