Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ad1189a

Browse files
BrentSouzabrent-at-aammatifali
authored
feat(jfrog): support multiple repositories (coder#289)
Co-authored-by: bsouza <[email protected]> Co-authored-by: Muhammad Atif Ali <[email protected]>
1 parent 94e126f commit ad1189a

14 files changed

+508
-168
lines changed

‎jfrog-oauth/.npmrc.tftpl

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

‎jfrog-oauth/README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ Install the JF CLI and authenticate package managers with Artifactory using OAut
1717
```tf
1818
module "jfrog" {
1919
source = "registry.coder.com/modules/jfrog-oauth/coder"
20-
version = "1.0.15"
20+
version = "1.0.19"
2121
agent_id = coder_agent.example.id
2222
jfrog_url = "https://example.jfrog.io"
2323
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
2424
2525
package_managers = {
26-
"npm" : "npm",
27-
"go" : "go",
28-
"pypi" : "pypi"
26+
npm = ["npm", "@scoped:npm-scoped"]
27+
go = ["go", "another-go-repo"]
28+
pypi = ["pypi", "extra-index-pypi"]
29+
docker = ["example-docker-staging.jfrog.io", "example-docker-production.jfrog.io"]
2930
}
3031
}
3132
```
@@ -44,13 +45,13 @@ Configure the Python pip package manager to fetch packages from Artifactory whil
4445
```tf
4546
module "jfrog" {
4647
source = "registry.coder.com/modules/jfrog-oauth/coder"
47-
version = "1.0.15"
48+
version = "1.0.19"
4849
agent_id = coder_agent.example.id
4950
jfrog_url = "https://example.jfrog.io"
5051
username_field = "email"
5152
5253
package_managers = {
53-
"pypi" : "pypi"
54+
pypi = ["pypi"]
5455
}
5556
}
5657
```
@@ -72,15 +73,15 @@ The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extensio
7273
```tf
7374
module "jfrog" {
7475
source = "registry.coder.com/modules/jfrog-oauth/coder"
75-
version = "1.0.15"
76+
version = "1.0.19"
7677
agent_id = coder_agent.example.id
7778
jfrog_url = "https://example.jfrog.io"
7879
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
7980
configure_code_server = true # Add JFrog extension configuration for code-server
8081
package_managers = {
81-
"npm" : "npm",
82-
"go" : "go",
83-
"pypi" : "pypi"
82+
npm = ["npm"]
83+
go = ["go"]
84+
pypi = ["pypi"]
8485
}
8586
}
8687
```

‎jfrog-oauth/main.test.ts

+119-9
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,129 @@
1-
import { serve } from "bun";
2-
import { describe } from "bun:test";
1+
import { describe, expect, it } from "bun:test";
32
import {
4-
createJSONResponse,
3+
findResourceInstance,
54
runTerraformInit,
5+
runTerraformApply,
66
testRequiredVariables,
77
} from "../test";
88

99
describe("jfrog-oauth", async () => {
10+
type TestVariables = {
11+
agent_id: string;
12+
jfrog_url: string;
13+
package_managers: string;
14+
15+
username_field?: string;
16+
jfrog_server_id?: string;
17+
external_auth_id?: string;
18+
configure_code_server?: boolean;
19+
};
20+
1021
await runTerraformInit(import.meta.dir);
1122

12-
testRequiredVariables(import.meta.dir, {
13-
agent_id: "some-agent-id",
14-
jfrog_url: "http://localhost:8081",
15-
package_managers: "{}",
23+
const fakeFrogApi = "localhost:8081/artifactory/api";
24+
const fakeFrogUrl = "http://localhost:8081";
25+
const user = "default";
26+
27+
it("can run apply with required variables", async () => {
28+
testRequiredVariables<TestVariables>(import.meta.dir, {
29+
agent_id: "some-agent-id",
30+
jfrog_url: fakeFrogUrl,
31+
package_managers: "{}",
32+
});
1633
});
17-
});
1834

19-
//TODO add more tests
35+
it("generates an npmrc with scoped repos", async () => {
36+
const state = await runTerraformApply<TestVariables>(import.meta.dir, {
37+
agent_id: "some-agent-id",
38+
jfrog_url: fakeFrogUrl,
39+
package_managers: JSON.stringify({
40+
npm: ["global", "@foo:foo", "@bar:bar"],
41+
}),
42+
});
43+
const coderScript = findResourceInstance(state, "coder_script");
44+
const npmrcStanza = `cat << EOF > ~/.npmrc
45+
email=${user}@example.com
46+
registry=http://${fakeFrogApi}/npm/global
47+
//${fakeFrogApi}/npm/global/:_authToken=
48+
@foo:registry=http://${fakeFrogApi}/npm/foo
49+
//${fakeFrogApi}/npm/foo/:_authToken=
50+
@bar:registry=http://${fakeFrogApi}/npm/bar
51+
//${fakeFrogApi}/npm/bar/:_authToken=
52+
53+
EOF`;
54+
expect(coderScript.script).toContain(npmrcStanza);
55+
expect(coderScript.script).toContain(
56+
'jf npmc --global --repo-resolve "global"',
57+
);
58+
expect(coderScript.script).toContain(
59+
'if [ -z "YES" ]; then\n not_configured npm',
60+
);
61+
});
62+
63+
it("generates a pip config with extra-indexes", async () => {
64+
const state = await runTerraformApply<TestVariables>(import.meta.dir, {
65+
agent_id: "some-agent-id",
66+
jfrog_url: fakeFrogUrl,
67+
package_managers: JSON.stringify({
68+
pypi: ["global", "foo", "bar"],
69+
}),
70+
});
71+
const coderScript = findResourceInstance(state, "coder_script");
72+
const pipStanza = `cat << EOF > ~/.pip/pip.conf
73+
[global]
74+
index-url = https://${user}:@${fakeFrogApi}/pypi/global/simple
75+
extra-index-url =
76+
https://${user}:@${fakeFrogApi}/pypi/foo/simple
77+
https://${user}:@${fakeFrogApi}/pypi/bar/simple
78+
79+
EOF`;
80+
expect(coderScript.script).toContain(pipStanza);
81+
expect(coderScript.script).toContain(
82+
'jf pipc --global --repo-resolve "global"',
83+
);
84+
expect(coderScript.script).toContain(
85+
'if [ -z "YES" ]; then\n not_configured pypi',
86+
);
87+
});
88+
89+
it("registers multiple docker repos", async () => {
90+
const state = await runTerraformApply<TestVariables>(import.meta.dir, {
91+
agent_id: "some-agent-id",
92+
jfrog_url: fakeFrogUrl,
93+
package_managers: JSON.stringify({
94+
docker: ["foo.jfrog.io", "bar.jfrog.io", "baz.jfrog.io"],
95+
}),
96+
});
97+
const coderScript = findResourceInstance(state, "coder_script");
98+
const dockerStanza = ["foo", "bar", "baz"]
99+
.map((r) => `register_docker "${r}.jfrog.io"`)
100+
.join("\n");
101+
expect(coderScript.script).toContain(dockerStanza);
102+
expect(coderScript.script).toContain(
103+
'if [ -z "YES" ]; then\n not_configured docker',
104+
);
105+
});
106+
107+
it("sets goproxy with multiple repos", async () => {
108+
const state = await runTerraformApply<TestVariables>(import.meta.dir, {
109+
agent_id: "some-agent-id",
110+
jfrog_url: fakeFrogUrl,
111+
package_managers: JSON.stringify({
112+
go: ["foo", "bar", "baz"],
113+
}),
114+
});
115+
const proxyEnv = findResourceInstance(state, "coder_env", "goproxy");
116+
const proxies = ["foo", "bar", "baz"]
117+
.map((r) => `https://${user}:@${fakeFrogApi}/go/${r}`)
118+
.join(",");
119+
expect(proxyEnv["value"]).toEqual(proxies);
120+
121+
const coderScript = findResourceInstance(state, "coder_script");
122+
expect(coderScript.script).toContain(
123+
'jf goc --global --repo-resolve "foo"',
124+
);
125+
expect(coderScript.script).toContain(
126+
'if [ -z "YES" ]; then\n not_configured go',
127+
);
128+
});
129+
});

‎jfrog-oauth/main.tf

+61-27
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,51 @@ variable "configure_code_server" {
5353
}
5454

5555
variable "package_managers" {
56-
type = map(string)
57-
description = <<EOF
58-
A map of package manager names to their respective artifactory repositories.
59-
For example:
60-
{
61-
"npm": "YOUR_NPM_REPO_KEY",
62-
"go": "YOUR_GO_REPO_KEY",
63-
"pypi": "YOUR_PYPI_REPO_KEY",
64-
"docker": "YOUR_DOCKER_REPO_KEY"
65-
}
66-
EOF
56+
type = object({
57+
npm = optional(list(string), [])
58+
go = optional(list(string), [])
59+
pypi = optional(list(string), [])
60+
docker = optional(list(string), [])
61+
})
62+
description = <<-EOF
63+
A map of package manager names to their respective artifactory repositories. Unused package managers can be omitted.
64+
For example:
65+
{
66+
npm = ["GLOBAL_NPM_REPO_KEY", "@SCOPED:NPM_REPO_KEY"]
67+
go = ["YOUR_GO_REPO_KEY", "ANOTHER_GO_REPO_KEY"]
68+
pypi = ["YOUR_PYPI_REPO_KEY", "ANOTHER_PYPI_REPO_KEY"]
69+
docker = ["YOUR_DOCKER_REPO_KEY", "ANOTHER_DOCKER_REPO_KEY"]
70+
}
71+
EOF
6772
}
6873

6974
locals {
7075
# The username field to use for artifactory
7176
username = var.username_field == "email" ? data.coder_workspace_owner.me.email : data.coder_workspace_owner.me.name
72-
jfrog_host = replace(var.jfrog_url, "https://", "")
77+
jfrog_host = split("://", var.jfrog_url)[1]
78+
common_values = {
79+
JFROG_URL = var.jfrog_url
80+
JFROG_HOST = local.jfrog_host
81+
JFROG_SERVER_ID = var.jfrog_server_id
82+
ARTIFACTORY_USERNAME = local.username
83+
ARTIFACTORY_EMAIL = data.coder_workspace_owner.me.email
84+
ARTIFACTORY_ACCESS_TOKEN = data.coder_external_auth.jfrog.access_token
85+
}
86+
npmrc = templatefile(
87+
"${path.module}/.npmrc.tftpl",
88+
merge(
89+
local.common_values,
90+
{
91+
REPOS = [
92+
for r in var.package_managers.npm :
93+
strcontains(r, ":") ? zipmap(["SCOPE", "NAME"], ["${split(":", r)[0]}:", split(":", r)[1]]) : { SCOPE = "", NAME = r }
94+
]
95+
}
96+
)
97+
)
98+
pip_conf = templatefile(
99+
"${path.module}/pip.conf.tftpl", merge(local.common_values, { REPOS = var.package_managers.pypi })
100+
)
73101
}
74102

75103
data "coder_workspace" "me" {}
@@ -83,19 +111,22 @@ resource "coder_script" "jfrog" {
83111
agent_id = var.agent_id
84112
display_name = "jfrog"
85113
icon = "/icon/jfrog.svg"
86-
script = templatefile("${path.module}/run.sh", {
87-
JFROG_URL : var.jfrog_url,
88-
JFROG_HOST : local.jfrog_host,
89-
JFROG_SERVER_ID : var.jfrog_server_id,
90-
ARTIFACTORY_USERNAME : local.username,
91-
ARTIFACTORY_EMAIL : data.coder_workspace_owner.me.email,
92-
ARTIFACTORY_ACCESS_TOKEN : data.coder_external_auth.jfrog.access_token,
93-
CONFIGURE_CODE_SERVER : var.configure_code_server,
94-
REPOSITORY_NPM : lookup(var.package_managers, "npm", ""),
95-
REPOSITORY_GO : lookup(var.package_managers, "go", ""),
96-
REPOSITORY_PYPI : lookup(var.package_managers, "pypi", ""),
97-
REPOSITORY_DOCKER : lookup(var.package_managers, "docker", ""),
98-
})
114+
script = templatefile("${path.module}/run.sh", merge(
115+
local.common_values,
116+
{
117+
CONFIGURE_CODE_SERVER = var.configure_code_server
118+
HAS_NPM = length(var.package_managers.npm) == 0 ? "" : "YES"
119+
NPMRC = local.npmrc
120+
REPOSITORY_NPM = try(element(var.package_managers.npm, 0), "")
121+
HAS_GO = length(var.package_managers.go) == 0 ? "" : "YES"
122+
REPOSITORY_GO = try(element(var.package_managers.go, 0), "")
123+
HAS_PYPI = length(var.package_managers.pypi) == 0 ? "" : "YES"
124+
PIP_CONF = local.pip_conf
125+
REPOSITORY_PYPI = try(element(var.package_managers.pypi, 0), "")
126+
HAS_DOCKER = length(var.package_managers.docker) == 0 ? "" : "YES"
127+
REGISTER_DOCKER = join("\n", formatlist("register_docker \"%s\"", var.package_managers.docker))
128+
}
129+
))
99130
run_on_start = true
100131
}
101132

@@ -121,10 +152,13 @@ resource "coder_env" "jfrog_ide_store_connection" {
121152
}
122153

123154
resource "coder_env" "goproxy" {
124-
count = lookup(var.package_managers, "go", "") == "" ? 0 : 1
155+
count = length(var.package_managers.go) == 0 ? 0 : 1
125156
agent_id = var.agent_id
126157
name = "GOPROXY"
127-
value = "https://${local.username}:${data.coder_external_auth.jfrog.access_token}@${local.jfrog_host}/artifactory/api/go/${lookup(var.package_managers, "go", "")}"
158+
value = join(",", [
159+
for repo in var.package_managers.go :
160+
"https://${local.username}:${data.coder_external_auth.jfrog.access_token}@${local.jfrog_host}/artifactory/api/go/${repo}"
161+
])
128162
}
129163

130164
output "access_token" {

‎jfrog-oauth/pip.conf.tftpl

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

0 commit comments

Comments
 (0)