Skip to content

Fix warning for PAT-like token with username #3579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbg merged 11 commits into from
Mar 25, 2026
+247 −80
Merged

Fix warning for PAT-like token with username #3579

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
193dd19
Add snippet to scaffold `test.macro`s
mbg Mar 16, 2026
6e67ef6
Refactor PAT test into a `test.macro`
mbg Mar 16, 2026
f86097d
Add params for `credentials` and `checkAccepted` to `testPATWarning`
mbg Mar 16, 2026
0393130
Add "token without a username" test
mbg Mar 16, 2026
740f177
Add `assertNotLogged` test helper
mbg Feb 24, 2026
ddafddb
Replace `getRecordingLogger` implementation with `RecordingLogger`
mbg Feb 24, 2026
de06821
Add `hasMessage` to `RecordingLogger`
mbg Feb 24, 2026
28f515d
Add tests for the absence of the warning
mbg Mar 16, 2026
f88d49e
Fix warning for PAT-like token with username
mbg Mar 16, 2026
d128e5d
Fix test names
mbg Mar 25, 2026
137e0de
Merge remote-tracking branch 'origin/main' into mbg/start-proxy/token…
mbg Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Refactor PAT test into a test.macro
  • Loading branch information
@mbg
mbg committed Mar 16, 2026
commit 6e67ef61f266b641e068a9727bc22f7fef13cc5e
69 changes: 38 additions & 31 deletions src/start-proxy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,42 +439,49 @@ test("getCredentials accepts OIDC configurations", (t) => {
t.assert(credentials.some((c) => startProxyExports.isJFrogConfig(c)));
});

test("getCredentials logs a warning when a PAT is used without a username", async (t) => {
const loggedMessages = [];
const logger = getRecordingLogger(loggedMessages);
const likelyWrongCredentials = toEncodedJSON([
{
type: "git_server",
host: "https://github.com/",
password: `ghp_${makeTestToken()}`,
},
]);

const results = startProxyExports.getCredentials(
logger,
undefined,
likelyWrongCredentials,
undefined,
);
const testPATWarning = test.macro({
exec: async (t: ExecutionContext<unknown>) => {
const loggedMessages = [];
const logger = getRecordingLogger(loggedMessages);
const likelyWrongCredentials = toEncodedJSON([
{
type: "git_server",
host: "https://github.com/",
password: `ghp_${makeTestToken()}`,
},
]);

// The configuration should be accepted, despite the likely problem.
t.assert(results);
t.is(results.length, 1);
t.is(results[0].type, "git_server");
t.is(results[0].host, "https://github.com/");
const results = startProxyExports.getCredentials(
logger,
undefined,
likelyWrongCredentials,
undefined,
);

if (startProxyExports.isUsernamePassword(results[0])) {
t.assert(results[0].password?.startsWith("ghp_"));
} else {
t.fail("Expected a `UsernamePassword`-based credential.");
}
// The configuration should be accepted, despite the likely problem.
t.assert(results);
t.is(results.length, 1);
t.is(results[0].type, "git_server");
t.is(results[0].host, "https://github.com/");

if (startProxyExports.isUsernamePassword(results[0])) {
t.assert(results[0].password?.startsWith("ghp_"));
} else {
t.fail("Expected a `UsernamePassword`-based credential.");
}

// A warning should have been logged.
checkExpectedLogMessages(t, loggedMessages, [
"using a GitHub Personal Access Token (PAT), but no username was provided",
]);
},

// A warning should have been logged.
checkExpectedLogMessages(t, loggedMessages, [
"using a GitHub Personal Access Token (PAT), but no username was provided",
]);
title: (providedTitle = "") =>
`getCredentials logs a warning when a PAT is used - ${providedTitle}`,
});

test("password without a username", testPATWarning);

test("getCredentials returns all credentials for Actions when using LANGUAGE_TO_REGISTRY_TYPE", async (t) => {
const credentialsInput = toEncodedJSON(mixedCredentials);

Expand Down