test: add more test for credential

Author: linonetwo

src/commitAndSync.ts

@@ -185,7 +185,7 @@ export async function commitAndSync(options: ICommitAndSyncOptions): Promise<voi
     }
   } finally {
     // always restore original remoteUrl without token
-    await credentialOff(dir, remoteUrl);
+    await credentialOff(dir, remoteName, remoteUrl);
   }
 }
 

src/credential.ts

@@ -2,19 +2,36 @@ import { GitProcess } from 'dugite';
 import { trim } from 'lodash';
 import { getRemoteUrl } from './inspect';
 
+export enum ServiceType {
+  Github = 'github',
+}
+
 // TODO: support folderLocation as rawUrl like `/Users/linonetwo/Desktop/repo/git-sync-js/test/mockUpstreamRepo/credential` for test, or gitlab url.
-export const getGitUrlWithCredential = (rawUrl: string, username: string, accessToken: string): string =>
+export const getGitHubUrlWithCredential = (rawUrl: string, username: string, accessToken: string): string =>
   trim(rawUrl.replaceAll('\n', '').replace('https://github.com/', `https://${username}:${accessToken}@github.com/`));
-const getGitUrlWithOutCredential = (urlWithCredential: string): string => trim(urlWithCredential.replace(/.+@/, 'https://'));
+const getGitHubUrlWithOutCredential = (urlWithCredential: string): string => trim(urlWithCredential.replace(/.+@/, 'https://'));
 
 /**
  *  Add remote with credential
  * @param {string} directory
  * @param {string} remoteUrl
  * @param {{ login: string, email: string, accessToken: string }} userInfo
  */
-export async function credentialOn(directory: string, remoteUrl: string, userName: string, accessToken: string, remoteName: string): Promise<void> {
-  const gitUrlWithCredential = getGitUrlWithCredential(remoteUrl, userName, accessToken);
+export async function credentialOn(
+  directory: string,
+  remoteUrl: string,
+  userName: string,
+  accessToken: string,
+  remoteName: string,
+  serviceType = ServiceType.Github,
+): Promise<void> {
+  let gitUrlWithCredential;
+  switch (serviceType) {
+    case ServiceType.Github: {
+      gitUrlWithCredential = getGitHubUrlWithCredential(remoteUrl, userName, accessToken);
+      break;
+    }
+  }
   await GitProcess.exec(['remote', 'add', remoteName, gitUrlWithCredential], directory);
   await GitProcess.exec(['remote', 'set-url', remoteName, gitUrlWithCredential], directory);
 }
@@ -24,8 +41,14 @@ export async function credentialOn(directory: string, remoteUrl: string, userNam
  * @param {string} githubRepoUrl
  * @param {{ login: string, email: string, accessToken: string }} userInfo
  */
-export async function credentialOff(directory: string, remoteName: string, remoteUrl?: string): Promise<void> {
-  const githubRepoUrl = remoteUrl ?? (await getRemoteUrl(directory, remoteName));
-  const gitUrlWithOutCredential = getGitUrlWithOutCredential(githubRepoUrl);
+export async function credentialOff(directory: string, remoteName: string, remoteUrl?: string, serviceType = ServiceType.Github): Promise<void> {
+  const gitRepoUrl = remoteUrl ?? (await getRemoteUrl(directory, remoteName));
+  let gitUrlWithOutCredential;
+  switch (serviceType) {
+    case ServiceType.Github: {
+      gitUrlWithOutCredential = getGitHubUrlWithOutCredential(gitRepoUrl);
+      break;
+    }
+  }
   await GitProcess.exec(['remote', 'set-url', remoteName, gitUrlWithOutCredential], directory);
 }

test/commitAndSync.test.ts

@@ -1,8 +1,11 @@
 /* eslint-disable security/detect-non-literal-fs-filename */
+import { omit } from 'lodash';
 import { commitAndSync, ICommitAndSyncOptions } from '../src/commitAndSync';
 import { defaultGitInfo } from '../src/defaultGitInfo';
-import { getSyncState, SyncState } from '../src/inspect';
+import { GitPullPushError } from '../src/errors';
+import { getRemoteUrl, getSyncState, SyncState } from '../src/inspect';
 import {
+  creatorGitInfo,
   // eslint-disable-next-line unicorn/prevent-abbreviations
   dir,
   exampleToken,
@@ -24,4 +27,26 @@ describe('commitAndSync', () => {
     await commitAndSync(getCommitAndSyncOptions());
     expect(await getSyncState(dir, defaultGitInfo.branch, defaultGitInfo.remote)).toBe<SyncState>('equal');
   });
+  test('restore Github credential after failed', async () => {
+    // can't push to github during test, so we use a fake token and only test failed situation
+    const creatorRepoUrl = `https://github.com/${creatorGitInfo.gitUserName}/wiki`;
+    expect(await getSyncState(dir, defaultGitInfo.branch, defaultGitInfo.remote)).toBe<SyncState>('noUpstreamOrBareUpstream');
+    await addSomeFiles();
+    const options = {
+      dir,
+      remoteUrl: creatorRepoUrl,
+      userInfo: { ...creatorGitInfo, branch: 'main' },
+    };
+    await expect(async () => await commitAndSync(options)).rejects.toThrow(
+      new GitPullPushError(
+        // print the same error message as Error...
+        { ...omit(options, ['remoteUrl', 'userInfo']), branch: 'main', remote: 'origin', userInfo: options.userInfo },
+        `remote: Invalid username or password.
+fatal: Authentication failed for 'https://github.com/linonetwo/wiki/'
+`,
+      ),
+    );
+    const restoredRemoteUrl = await getRemoteUrl(dir, defaultGitInfo.remote);
+    expect(restoredRemoteUrl).toBe(creatorRepoUrl);
+  });
 });

test/constants.ts

@@ -2,6 +2,7 @@
 /* eslint-disable unicorn/prevent-abbreviations */
 /* eslint-disable unicorn/prefer-module */
 import path from 'path';
+import { IGitUserInfos } from '../src/interface';
 
 /**
  * Random dir name to prevent parallel test execution collision
@@ -23,6 +24,14 @@ export let upstreamDirGitDirectory: string;
 export let gitSyncRepoDirectory: string;
 export let gitSyncRepoDirectoryGitDirectory: string;
 
+export const creatorGitInfo: IGitUserInfos & { remote: string } = {
+  email: 'gitsync@gmail.com',
+  gitUserName: 'linonetwo',
+  branch: 'master',
+  remote: 'origin',
+  accessToken: 'ghp_zA8Xet3mupV6kWj2sFsKUpTv45hJA6ZJyzY6',
+};
+
 /**
  * use currentTestName to get better constants, should call in jest functions as early as possible
  */

test/credential.test.ts

@@ -1,7 +1,7 @@
-import { credentialOff, credentialOn, getGitUrlWithCredential, getRemoteUrl } from '../src';
+import { credentialOff, credentialOn, getGitHubUrlWithCredential, getRemoteUrl } from '../src';
 import { defaultGitInfo } from '../src/defaultGitInfo';
 import { getGitUrlWithGitSuffix, getGitUrlWithOutGitSuffix } from '../src/utils';
-import { dir, exampleRemoteUrl, exampleToken } from './constants';
+import { creatorGitInfo, dir, exampleRemoteUrl, exampleToken } from './constants';
 import { addHTTPRemote } from './utils';
 
 describe('credential', () => {
@@ -15,7 +15,7 @@ describe('credential', () => {
     // make sure we are working on a https remote, our method only handle this case
     expect(remoteUrl).toStartWith('https://');
     expect(remoteUrl.length).toBeGreaterThan(0);
-    expect(remoteUrl).toBe(getGitUrlWithCredential(exampleRemoteUrl, defaultGitInfo.gitUserName, exampleToken));
+    expect(remoteUrl).toBe(getGitHubUrlWithCredential(exampleRemoteUrl, defaultGitInfo.gitUserName, exampleToken));
     // github use https://${username}:${accessToken}@github.com/ format
     expect(remoteUrl.includes('@')).toBe(true);
     expect(remoteUrl.includes(exampleToken)).toBe(true);
@@ -58,6 +58,33 @@ describe('credential', () => {
     expect(restoredRemoteUrl.includes(exampleToken)).toBe(false);
   });
 
+  test('it remove Github token after off (specific case of creator)', async () => {
+    const creatorRepoUrl = `https://github.com/${creatorGitInfo.gitUserName}/wiki`;
+    const creatorRepoUrlWithToken = `https://${creatorGitInfo.gitUserName}:${creatorGitInfo.accessToken}@github.com/${creatorGitInfo.gitUserName}/wiki`;
+    await credentialOn(dir, creatorRepoUrl, creatorGitInfo.gitUserName, creatorGitInfo.accessToken, defaultGitInfo.remote);
+    const newRemoteUrl = await getRemoteUrl(dir, defaultGitInfo.remote);
+    expect(newRemoteUrl.includes(creatorGitInfo.accessToken)).toBe(true);
+    expect(newRemoteUrl).toBe(creatorRepoUrlWithToken);
+    await credentialOff(dir, defaultGitInfo.remote);
+    const restoredRemoteUrl = await getRemoteUrl(dir, defaultGitInfo.remote);
+    expect(restoredRemoteUrl).toBe(creatorRepoUrl);
+    expect(restoredRemoteUrl.includes(exampleToken)).toBe(false);
+  });
+
+  test('it remove Github token from url with token (specific case of creator)', async () => {
+    const creatorRepoUrl = `https://github.com/${creatorGitInfo.gitUserName}/wiki`;
+    const creatorRepoUrlWithToken = `https://${creatorGitInfo.gitUserName}:${creatorGitInfo.accessToken}@github.com/${creatorGitInfo.gitUserName}/wiki`;
+    // sometimes, original url has token (forget to remove) due to bugs in previous versions.
+    await credentialOn(dir, creatorRepoUrlWithToken, creatorGitInfo.gitUserName, creatorGitInfo.accessToken, defaultGitInfo.remote);
+    const newRemoteUrl = await getRemoteUrl(dir, defaultGitInfo.remote);
+    expect(newRemoteUrl.includes(creatorGitInfo.accessToken)).toBe(true);
+    expect(newRemoteUrl).toBe(creatorRepoUrlWithToken);
+    await credentialOff(dir, defaultGitInfo.remote);
+    const restoredRemoteUrl = await getRemoteUrl(dir, defaultGitInfo.remote);
+    expect(restoredRemoteUrl).toBe(creatorRepoUrl);
+    expect(restoredRemoteUrl.includes(exampleToken)).toBe(false);
+  });
+
   test('methods are idempotent', async () => {
     const originalRemoteUrl = await getRemoteUrl(dir, defaultGitInfo.remote);
     await credentialOn(dir, originalRemoteUrl, defaultGitInfo.gitUserName, exampleToken, defaultGitInfo.remote);