publicWagsHome
/
modules
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Support for multiple repos

Browse Source
pull/289/head
bsouza 10 months ago
parent 31c29fa9c4
commit 646adbcc51
5 changed files with 198 additions and 54 deletions
Show Stats Download Patch File Download Diff File

5
jfrog-token/.npmrc.tftpl
Unescape Escape View File

@ -0,0 +1,5 @@
email=${ARTIFACTORY_EMAIL}
%{ for REPO in REPOS ~}
${REPO.SCOPE}registry=${JFROG_URL}/artifactory/api/npm/${REPO.NAME}
//${JFROG_HOST}/artifactory/api/npm/${REPO.NAME}/:_authToken=${ARTIFACTORY_ACCESS_TOKEN}
%{ endfor ~}

94
jfrog-token/main.test.ts
Unescape Escape View File

@ -1,8 +1,10 @@
import { serve } from "bun"; import { serve } from "bun";
import { describe } from "bun:test"; import { describe, expect, it } from "bun:test";
import { import {
createJSONResponse, createJSONResponse,
findResourceInstance,
runTerraformInit, runTerraformInit,
runTerraformApply,
testRequiredVariables, testRequiredVariables,
} from "../test"; } from "../test";
@ -32,10 +34,98 @@ describe("jfrog-token", async () => {
port: 0, port: 0,
}); });
const fakeFrogHostAndPort = `${fakeFrogHost.hostname}:${fakeFrogHost.port}`;
const fakeFrogUrl = `http://${fakeFrogHostAndPort}`;
it("can run apply with required variables", async () => {
testRequiredVariables(import.meta.dir, { testRequiredVariables(import.meta.dir, {
agent_id: "some-agent-id", agent_id: "some-agent-id",
jfrog_url: "http://" + fakeFrogHost.hostname + ":" + fakeFrogHost.port, jfrog_url: fakeFrogUrl,
artifactory_access_token: "XXXX", artifactory_access_token: "XXXX",
package_managers: "{}", package_managers: "{}",
}); });
}); });
it("generates an npmrc with scoped repos", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "some-agent-id",
jfrog_url: fakeFrogUrl,
artifactory_access_token: "XXXX",
package_managers: JSON.stringify({
npm: ["global", "@foo:foo", "@bar:bar"],
}),
});
const coderScript = findResourceInstance(state, "coder_script");
const npmrcStanza = `cat << EOF > ~/.npmrc
email=default@example.com
registry=${fakeFrogUrl}/artifactory/api/npm/global
//${fakeFrogHostAndPort}/artifactory/api/npm/global/:_authToken=xxx
@foo:registry=${fakeFrogUrl}/artifactory/api/npm/foo
//${fakeFrogHostAndPort}/artifactory/api/npm/foo/:_authToken=xxx
@bar:registry=${fakeFrogUrl}/artifactory/api/npm/bar
//${fakeFrogHostAndPort}/artifactory/api/npm/bar/:_authToken=xxx
EOF`;
expect(coderScript.script).toContain(npmrcStanza);
expect(coderScript.script).toContain('jf npmc --global --repo-resolve "global"');
expect(coderScript.script).toContain('if [ -z "YES" ]; then\n not_configured npm');
});
it("generates a pip config with extra-indexes", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "some-agent-id",
jfrog_url: fakeFrogUrl,
artifactory_access_token: "XXXX",
package_managers: JSON.stringify({
pypi: ["global", "foo", "bar"],
}),
});
const coderScript = findResourceInstance(state, "coder_script");
const pipStanza = `cat << EOF > ~/.pip/pip.conf
[global]
index-url = https://default:xxx@${fakeFrogHostAndPort}/artifactory/api/pypi/global/simple
extra-index-url =
https://default:xxx@${fakeFrogHostAndPort}/artifactory/api/pypi/foo/simple
https://default:xxx@${fakeFrogHostAndPort}/artifactory/api/pypi/bar/simple
EOF`;
expect(coderScript.script).toContain(pipStanza);
expect(coderScript.script).toContain('jf pipc --global --repo-resolve "global"');
expect(coderScript.script).toContain('if [ -z "YES" ]; then\n not_configured pypi');
});
it("registers multiple docker repos", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "some-agent-id",
jfrog_url: fakeFrogUrl,
artifactory_access_token: "XXXX",
package_managers: JSON.stringify({
docker: ["foo.jfrog.io", "bar.jfrog.io", "baz.jfrog.io"],
}),
});
const coderScript = findResourceInstance(state, "coder_script");
const dockerStanza = `register_docker "foo.jfrog.io"
register_docker "bar.jfrog.io"
register_docker "baz.jfrog.io"`;
expect(coderScript.script).toContain(dockerStanza);
expect(coderScript.script).toContain('if [ -z "YES" ]; then\n not_configured docker');
});
it("sets goproxy with multiple repos", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "some-agent-id",
jfrog_url: fakeFrogUrl,
artifactory_access_token: "XXXX",
package_managers: JSON.stringify({
go: ["foo", "bar", "baz"],
}),
});
const proxyEnv = findResourceInstance(state, "coder_env", "goproxy");
const proxies = `https://default:xxx@${fakeFrogHostAndPort}/artifactory/api/go/foo,https://default:xxx@${fakeFrogHostAndPort}/artifactory/api/go/bar,https://default:xxx@${fakeFrogHostAndPort}/artifactory/api/go/baz`;
expect(proxyEnv["value"]).toEqual(proxies);
const coderScript = findResourceInstance(state, "coder_script");
expect(coderScript.script).toContain('jf goc --global --repo-resolve "foo"');
expect(coderScript.script).toContain('if [ -z "YES" ]; then\n not_configured go');
});
});

80
jfrog-token/main.tf
Unescape Escape View File

@ -80,15 +80,20 @@ variable "configure_code_server" {
} }
variable "package_managers" { variable "package_managers" {
type = map(string) type = object({
description = <<EOF npm = optional(list(string), [])
A map of package manager names to their respective artifactory repositories. go = optional(list(string), [])
pypi = optional(list(string), [])
docker = optional(list(string), [])
})
description = <<-EOF
A map of package manager names to their respective artifactory repositories. Unused package managers can be omitted.
For example: For example:
{ {
"npm": "YOUR_NPM_REPO_KEY", npm = ["GLOBAL_NPM_REPO_KEY", "@SCOPED:NPM_REPO_KEY"]
"go": "YOUR_GO_REPO_KEY", go = ["YOUR_GO_REPO_KEY", "ANOTHER_GO_REPO_KEY"]
"pypi": "YOUR_PYPI_REPO_KEY", pypi = ["YOUR_PYPI_REPO_KEY", "ANOTHER_PYPI_REPO_KEY"]
"docker": "YOUR_DOCKER_REPO_KEY" docker = ["YOUR_DOCKER_REPO_KEY", "ANOTHER_DOCKER_REPO_KEY"]
} }
EOF EOF
} }
@ -96,7 +101,30 @@ EOF
locals { locals {
# The username field to use for artifactory # The username field to use for artifactory
username = var.username_field == "email" ? data.coder_workspace_owner.me.email : data.coder_workspace_owner.me.name username = var.username_field == "email" ? data.coder_workspace_owner.me.email : data.coder_workspace_owner.me.name
jfrog_host = replace(var.jfrog_url, "https://", "") jfrog_host = split("://", var.jfrog_url)[1]
common_values = {
JFROG_URL = var.jfrog_url
JFROG_HOST = local.jfrog_host
JFROG_SERVER_ID = var.jfrog_server_id
ARTIFACTORY_USERNAME = local.username
ARTIFACTORY_EMAIL = data.coder_workspace_owner.me.email
ARTIFACTORY_ACCESS_TOKEN = artifactory_scoped_token.me.access_token
}
npmrc = templatefile(
"${path.module}/.npmrc.tftpl",
merge(
local.common_values,
{
REPOS = [
for r in var.package_managers.npm :
strcontains(r, ":") ? zipmap(["SCOPE", "NAME"], ["${split(":", r)[0]}:", split(":", r)[1]]) : { SCOPE = "", NAME = r }
]
}
)
)
pip_conf = templatefile(
"${path.module}/pip.conf.tftpl", merge(local.common_values, { REPOS = var.package_managers.pypi })
)
} }
# Configure the Artifactory provider # Configure the Artifactory provider
@ -123,19 +151,22 @@ resource "coder_script" "jfrog" {
agent_id = var.agent_id agent_id = var.agent_id
display_name = "jfrog" display_name = "jfrog"
icon = "/icon/jfrog.svg" icon = "/icon/jfrog.svg"
script = templatefile("${path.module}/run.sh", { script = templatefile("${path.module}/run.sh", merge(
JFROG_URL : var.jfrog_url, local.common_values,
JFROG_HOST : local.jfrog_host, {
JFROG_SERVER_ID : var.jfrog_server_id, CONFIGURE_CODE_SERVER = var.configure_code_server
ARTIFACTORY_USERNAME : local.username, HAS_NPM = length(var.package_managers.npm) == 0 ? "" : "YES"
ARTIFACTORY_EMAIL : data.coder_workspace_owner.me.email, NPMRC = local.npmrc
ARTIFACTORY_ACCESS_TOKEN : artifactory_scoped_token.me.access_token, REPOSITORY_NPM = try(element(var.package_managers.npm, 0), "")
CONFIGURE_CODE_SERVER : var.configure_code_server, HAS_GO = length(var.package_managers.go) == 0 ? "" : "YES"
REPOSITORY_NPM : lookup(var.package_managers, "npm", ""), REPOSITORY_GO = try(element(var.package_managers.go, 0), "")
REPOSITORY_GO : lookup(var.package_managers, "go", ""), HAS_PYPI = length(var.package_managers.pypi) == 0 ? "" : "YES"
REPOSITORY_PYPI : lookup(var.package_managers, "pypi", ""), PIP_CONF = local.pip_conf
REPOSITORY_DOCKER : lookup(var.package_managers, "docker", ""), REPOSITORY_PYPI = try(element(var.package_managers.pypi, 0), "")
}) HAS_DOCKER = length(var.package_managers.docker) == 0 ? "" : "YES"
REGISTER_DOCKER = join("\n", formatlist("register_docker \"%s\"", var.package_managers.docker))
}
))
run_on_start = true run_on_start = true
} }
@ -161,10 +192,13 @@ resource "coder_env" "jfrog_ide_store_connection" {
} }
resource "coder_env" "goproxy" { resource "coder_env" "goproxy" {
count = lookup(var.package_managers, "go", "") == "" ? 0 : 1 count = length(var.package_managers.go) == 0 ? 0 : 1
agent_id = var.agent_id agent_id = var.agent_id
name = "GOPROXY" name = "GOPROXY"
value = "https://${local.username}:${artifactory_scoped_token.me.access_token}@${local.jfrog_host}/artifactory/api/go/${lookup(var.package_managers, "go", "")}" value = join(",", [
for repo in var.package_managers.go :
"https://${local.username}:${artifactory_scoped_token.me.access_token}@${local.jfrog_host}/artifactory/api/go/${repo}"
])
} }
output "access_token" { output "access_token" {

6
jfrog-token/pip.conf.tftpl
Unescape Escape View File

@ -0,0 +1,6 @@
[global]
index-url = https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@${JFROG_HOST}/artifactory/api/pypi/${try(element(REPOS, 0), "")}/simple
extra-index-url =
%{ for REPO in try(slice(REPOS, 1, length(REPOS)), []) ~}
https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@${JFROG_HOST}/artifactory/api/pypi/${REPO}/simple
%{ endfor ~}

51
jfrog-token/run.sh
Unescape Escape View File

@ -2,6 +2,21 @@
BOLD='\033[0;1m' BOLD='\033[0;1m'
func not_configured(){
type=$1
echo "🤔 no $type repository is set, skipping $type configuration."
echo "You can configure a $type repository by providing a key for '$type' in the 'package_managers' input."
}
func done(){
echo "🥳 Configuration complete!"
}
func register_docker(){
repo=$1
echo -n "${ARTIFACTORY_ACCESS_TOKEN}" | docker login "$repo" --username ${ARTIFACTORY_USERNAME} --password-stdin
}
# check if JFrog CLI is already installed # check if JFrog CLI is already installed
if command -v jf > /dev/null 2>&1; then if command -v jf > /dev/null 2>&1; then
echo "✅ JFrog CLI is already installed, skipping installation." echo "✅ JFrog CLI is already installed, skipping installation."
@ -11,8 +26,7 @@ else
sudo chmod 755 /usr/local/bin/jf sudo chmod 755 /usr/local/bin/jf
fi fi
# The jf CLI checks $CI when determining whether to use interactive # The jf CLI checks $CI when determining whether to use interactive flows.
# flows.
export CI=true export CI=true
# Authenticate JFrog CLI with Artifactory. # Authenticate JFrog CLI with Artifactory.
echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFROG_URL}" --overwrite "${JFROG_SERVER_ID}" echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFROG_URL}" --overwrite "${JFROG_SERVER_ID}"
@ -20,52 +34,47 @@ echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFRO
jf c use "${JFROG_SERVER_ID}" jf c use "${JFROG_SERVER_ID}"
# Configure npm to use the Artifactory "npm" repository. # Configure npm to use the Artifactory "npm" repository.
if [ -z "${REPOSITORY_NPM}" ]; then if [ -z "${HAS_NPM}" ]; then
echo "🤔 no npm repository is set, skipping npm configuration." not_configured npm
echo "You can configure an npm repository by providing the a key for 'npm' in the 'package_managers' input."
else else
echo "📦 Configuring npm..." echo "📦 Configuring npm..."
jf npmc --global --repo-resolve "${REPOSITORY_NPM}" jf npmc --global --repo-resolve "${REPOSITORY_NPM}"
cat << EOF > ~/.npmrc cat << EOF > ~/.npmrc
email=${ARTIFACTORY_EMAIL} ${NPMRC}
registry=${JFROG_URL}/artifactory/api/npm/${REPOSITORY_NPM}
EOF EOF
echo "//${JFROG_HOST}/artifactory/api/npm/${REPOSITORY_NPM}/:_authToken=${ARTIFACTORY_ACCESS_TOKEN}" >> ~/.npmrc echo "🥳 Configuration complete!"
fi fi
# Configure the `pip` to use the Artifactory "python" repository. # Configure the `pip` to use the Artifactory "python" repository.
if [ -z "${REPOSITORY_PYPI}" ]; then if [ -z "${HAS_PYPI}" ]; then
echo "🤔 no pypi repository is set, skipping pip configuration." not_configured pypi
echo "You can configure a pypi repository by providing the a key for 'pypi' in the 'package_managers' input."
else else
echo "🐍 Configuring pip..." echo "🐍 Configuring pip..."
jf pipc --global --repo-resolve "${REPOSITORY_PYPI}" jf pipc --global --repo-resolve "${REPOSITORY_PYPI}"
mkdir -p ~/.pip mkdir -p ~/.pip
cat << EOF > ~/.pip/pip.conf cat << EOF > ~/.pip/pip.conf
[global] ${PIP_CONF}
index-url = https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@${JFROG_HOST}/artifactory/api/pypi/${REPOSITORY_PYPI}/simple
EOF EOF
echo "🥳 Configuration complete!"
fi fi
# Configure Artifactory "go" repository. # Configure Artifactory "go" repository.
if [ -z "${REPOSITORY_GO}" ]; then if [ -z "${HAS_GO}" ]; then
echo "🤔 no go repository is set, skipping go configuration." not_configured go
echo "You can configure a go repository by providing the a key for 'go' in the 'package_managers' input."
else else
echo "🐹 Configuring go..." echo "🐹 Configuring go..."
jf goc --global --repo-resolve "${REPOSITORY_GO}" jf goc --global --repo-resolve "${REPOSITORY_GO}"
fi
echo "🥳 Configuration complete!" echo "🥳 Configuration complete!"
fi
# Configure the JFrog CLI to use the Artifactory "docker" repository. # Configure the JFrog CLI to use the Artifactory "docker" repository.
if [ -z "${REPOSITORY_DOCKER}" ]; then if [ -z "${HAS_DOCKER}" ]; then
echo "🤔 no docker repository is set, skipping docker configuration." not_configured docker
echo "You can configure a docker repository by providing the a key for 'docker' in the 'package_managers' input."
else else
if command -v docker > /dev/null 2>&1; then if command -v docker > /dev/null 2>&1; then
echo "🔑 Configuring 🐳 docker credentials..." echo "🔑 Configuring 🐳 docker credentials..."
mkdir -p ~/.docker mkdir -p ~/.docker
echo -n "${ARTIFACTORY_ACCESS_TOKEN}" | docker login ${JFROG_HOST} --username ${ARTIFACTORY_USERNAME} --password-stdin ${REGISTER_DOCKER}
else else
echo "🤔 no docker is installed, skipping docker configuration." echo "🤔 no docker is installed, skipping docker configuration."
fi fi

Write Preview
Loading…
Cancel
Save