feat(git-helper): Separate source and target repositories

Author: anibalsanchez

__tests__/composer-helper.test.ts

@@ -10,8 +10,9 @@ test('composer install & optimize', async () => {
   const composerVendor =
     inputHelper.baseDirPath + '/__tests__/Mock-Composer/vendor'
 
-  !fs.existsSync(composerLock) || await fs.promises.rm(composerLock)
-  !fs.existsSync(composerVendor) || await fs.promises.rm(composerVendor, {recursive: true})
+  !fs.existsSync(composerLock) || (await fs.promises.rm(composerLock))
+  !fs.existsSync(composerVendor) ||
+    (await fs.promises.rm(composerVendor, {recursive: true}))
 
   const composerHelper = await createComposerHelper(
     inputHelper.baseDirPath + '/__tests__/Mock-Composer'

__tests__/git-helper.test.ts

@@ -6,13 +6,15 @@ import {IGitHelper, createGitHelper} from '../src/git-helper'
 import {getExecOutput} from '@actions/exec'
 import {env, cwd} from 'process'
 import {createCommandManager} from '../src/git-command-manager'
+import {IGitSourceSettings} from 'github-checkout/lib/git-source-settings'
 
 let srcTmpPath: string | undefined
+let sourceSettings: IGitSourceSettings
 
 async function createTmpRepo(): Promise<IGitHelper> {
   srcTmpPath = await makeTempPath()
-
-  const gitHelper = await createGitHelper(srcTmpPath, false)
+  const settings = {...sourceSettings, repositoryPath: srcTmpPath}
+  const gitHelper = await createGitHelper(settings)
   await gitHelper.init()
 
   await getExecOutput(`touch ${srcTmpPath}/composer.json`)
@@ -33,8 +35,27 @@ async function destroyTmpRepo() {
 let gitHelper: IGitHelper
 
 beforeEach(async () => {
+  sourceSettings = {
+    repositoryPath: '',
+    repositoryOwner: '',
+    repositoryName: '',
+    ref: '',
+    commit: '',
+    clean: true,
+    fetchDepth: 1,
+    lfs: false,
+    submodules: false,
+    nestedSubmodules: false,
+    authToken: env.PHP_PREFIXER_GH_TOKEN || '',
+    sshKey: '',
+    sshKnownHosts: '',
+    sshStrict: true,
+    persistCredentials: true
+  }
+
   const inputHelper = new InputHelper()
-  gitHelper = await createGitHelper(inputHelper.baseDirPath, false)
+  sourceSettings.repositoryPath = inputHelper.baseDirPath
+  gitHelper = await createGitHelper(sourceSettings)
 
   env.GITHUB_REPOSITORY = 'lorem/ipsum'
 })
@@ -135,7 +156,8 @@ test('last matching tag no tag', async () => {
 
 test('push', async () => {
   const srcTmpPath = await makeTempPath()
-  const gitHelper = await createGitHelper(srcTmpPath, false)
+  const settings = {...sourceSettings, repositoryPath: srcTmpPath}
+  const gitHelper = await createGitHelper(settings)
   await gitHelper.init()
   await getExecOutput(`touch ${srcTmpPath}/composer.json`)
   await gitHelper.commitAll()
@@ -147,14 +169,16 @@ test('push', async () => {
   const targetTmpPath = await makeTempPath()
   await getExecOutput(`git clone ${upstreamTmpPath} ${targetTmpPath}`)
 
-  const targetIGitHelper = await createGitHelper(targetTmpPath, false)
+  const targetSettings = {...sourceSettings, repositoryPath: targetTmpPath}
+  const targetIGitHelper = await createGitHelper(targetSettings)
   const licenseFile = `${targetTmpPath}/license.txt`
   await getExecOutput(`touch ${licenseFile}`)
   await targetIGitHelper.commitAll()
   await targetIGitHelper.tag('1.2.4')
   await targetIGitHelper.push('origin', 'master')
 
-  const upstreamIGitHelper = await createGitHelper(upstreamTmpPath, false)
+  const upstreamSettings = {...sourceSettings, repositoryPath: upstreamTmpPath}
+  const upstreamIGitHelper = await createGitHelper(upstreamSettings)
   const result1 = await upstreamIGitHelper.tagExists('1.2.3')
   expect(result1).toBeTruthy()
   const result2 = await upstreamIGitHelper.tagExists('1.2.4')
@@ -187,7 +211,8 @@ test('tag exists', async () => {
 
 test('has changes', async () => {
   const srcTmpPath = await makeTempPath()
-  const gitHelper = await createGitHelper(srcTmpPath, false)
+  const settings = {...sourceSettings, repositoryPath: srcTmpPath}
+  const gitHelper = await createGitHelper(settings)
   await gitHelper.init()
 
   await fs.promises.mkdir(`${srcTmpPath}/vendor`)
@@ -219,7 +244,10 @@ test('remote add', async () => {
 
   if (srcTmpPath) {
     const commandManager = await createCommandManager(srcTmpPath, false)
-    await commandManager.config('remote.origin.url', 'git@github.com:PHP-Prefixer/php-prefixer-build-action.git')
+    await commandManager.config(
+      'remote.origin.url',
+      'git@github.com:PHP-Prefixer/php-prefixer-build-action.git'
+    )
     await tmpIGitHelper.remoteAdd(true, 'prefixed-origin-3')
     const result3 = await tmpIGitHelper.remoteExists('prefixed-origin-3')
     expect(result3).toBeTruthy()

__tests__/main-helper.test.ts

@@ -1,5 +1,5 @@
 import * as core from '@actions/core'
-import { env, cwd } from 'process'
+import {env, cwd} from 'process'
 import {test, expect} from '@jest/globals'
 import {run, cleanup} from '../src/main-helper'
 import * as checkoutInputHelper from 'github-checkout/lib/input-helper'
@@ -33,25 +33,25 @@ test('main', async () => {
 
   const now = new Date()
   const content = `Last build ${now.toISOString()}`
-  await fs.promises.writeFile(`${sourceSettings.repositoryPath}/last-build`, content)
-  const gitHelper = await createGitHelper(
-    sourceSettings.repositoryPath,
-    sourceSettings.lfs
+  await fs.promises.writeFile(
+    `${sourceSettings.repositoryPath}/last-build`,
+    content
   )
+  const gitHelper = await createGitHelper(sourceSettings)
   const currentBranch = await gitHelper.currentBranch()
   await gitHelper.commitAll()
-  await gitHelper.push(currentBranch)
+  await gitHelper.push('origin', currentBranch)
   await fs.promises.rm(sourceSettings.repositoryPath, {recursive: true})
   sourceSettings.repositoryPath = ''
 
-  core.debug('[main-helper.test] run err code 0')
+  core.debug('[main-helper.test] run err code 0 - to be prefixed')
   const errorCode0 = await run()
   expect(errorCode0).toBe(0)
   await cleanup()
 
-  core.debug('[main-helper.test] run err code 1')
+  core.debug('[main-helper.test] run err code 0 - already prefixed')
   const errorCode1 = await run()
-  expect(errorCode1).toBe(1)
+  expect(errorCode1).toBe(0)
   await cleanup()
 
   gitSourceProvider.cleanup(sourceSettings.repositoryPath)

__tests__/php-prefixer-helper.test.ts

@@ -12,10 +12,13 @@ import {PhpPrefixerHelper} from '../src/php-prefixer-helper'
 import InputHelper from '../src/input-helper'
 
 let srcTmpPath: string | undefined
+let sourceSettings: IGitSourceSettings
+let phpPrefixerSettings: IPhpPrefixerSettings
 
 async function createTmpRepo(): Promise<IGitHelper> {
   srcTmpPath = await makeTempPath()
-  const gitHelper = await createGitHelper(srcTmpPath, false)
+  const settings = {...sourceSettings, repositoryPath: srcTmpPath}
+  const gitHelper = await createGitHelper(settings)
   await gitHelper.init()
 
   await getExecOutput(`touch ${srcTmpPath}/composer.json`)
@@ -36,9 +39,6 @@ async function destroyTmpRepo() {
   srcTmpPath = undefined
 }
 
-let sourceSettings: IGitSourceSettings
-let phpPrefixerSettings: IPhpPrefixerSettings
-
 beforeEach(() => {
   sourceSettings = {
     repositoryPath: '',
@@ -65,6 +65,8 @@ beforeEach(() => {
     projectId: env.PHP_PREFIXER_PROJECT_ID || '',
     ghPersonalAccessToken: env.PHP_PREFIXER_GH_TOKEN || ''
   }
+
+  env.GITHUB_REPOSITORY = 'lorem/ipsum'
 })
 
 test('waiting job true - guzzle master / prefixed', async () => {
@@ -219,7 +221,8 @@ test('prefix - local master / prefixed', async () => {
   const mockedProject = inputHelper.baseDirPath + '/__tests__/Mock-PhpPrefixer'
 
   const srcTmpPath = await makeTempPath()
-  const gitHelper = await createGitHelper(srcTmpPath, false)
+  const settings = {...sourceSettings, repositoryPath: srcTmpPath}
+  const gitHelper = await createGitHelper(settings)
   await gitHelper.init()
   const rsync = await createRsync()
   await rsync.copyProjectFiles(mockedProject, srcTmpPath)
@@ -247,7 +250,8 @@ test('prefix - local master / prefixed', async () => {
   const resultPrefix1 = await phpPrefixerHelper.prefix()
   expect(resultPrefix1).toBeTruthy()
 
-  const upstreamIGitHelper = await createGitHelper(upstreamTmpPath, false)
+  const upstreamSettings = {...sourceSettings, repositoryPath: upstreamTmpPath}
+  const upstreamIGitHelper = await createGitHelper(upstreamSettings)
   const branchExists = await upstreamIGitHelper.branchExists(false, 'prefixed')
   expect(branchExists).toBeTruthy()
 
@@ -267,7 +271,8 @@ test('prefix - local master 7.1.1 / prefixed prefixed-7.1.1', async () => {
   const mockedProject = inputHelper.baseDirPath + '/__tests__/Mock-PhpPrefixer'
 
   const srcTmpPath = await makeTempPath()
-  const gitHelper = await createGitHelper(srcTmpPath, false)
+  const settings = {...sourceSettings, repositoryPath: srcTmpPath}
+  const gitHelper = await createGitHelper(settings)
   await gitHelper.init()
   const rsync = await createRsync()
   await rsync.copyProjectFiles(mockedProject, srcTmpPath)
@@ -295,7 +300,8 @@ test('prefix - local master 7.1.1 / prefixed prefixed-7.1.1', async () => {
 
   await phpPrefixerHelper.prefix()
 
-  const upstreamIGitHelper = await createGitHelper(upstreamTmpPath, false)
+  const upstreamSettings = {...sourceSettings, repositoryPath: upstreamTmpPath}
+  const upstreamIGitHelper = await createGitHelper(upstreamSettings)
   const branchExists = await upstreamIGitHelper.branchExists(false, 'prefixed')
   expect(branchExists).toBeTruthy()
   const tagExists = await upstreamIGitHelper.tagExists('prefixed-7.1.1')

src/git-command-manager.ts

@@ -44,7 +44,7 @@ export interface IGitCommandManager {
   lfsInstall(): Promise<void>
   log1(format?: string): Promise<string>
   pull(remote: string, branch: string): Promise<void>
-  push(branch: string): Promise<void>
+  push(remote: string, branch: string): Promise<void>
   remoteAdd(remoteName: string, remoteUrl: string): Promise<void>
   removeEnvironmentVariable(name: string): void
   remoteExists(remote: string): Promise<boolean>
@@ -353,14 +353,14 @@ class GitCommandManager {
     return output.stdout
   }
 
-  async push(branch: string): Promise<void> {
+  async push(remote: string, branch: string): Promise<void> {
     await this.execGit([
       'push',
       '--tags',
       '--progress',
       '--no-verify',
       '-u',
-      'origin',
+      remote,
       branch
     ])
   }

src/git-helper.ts

@@ -24,10 +24,9 @@ export interface IGitHelper {
 }
 
 export async function createGitHelper(
-  workingDirectory: string,
-  lfs: boolean
+  settings: IGitSourceSettings
 ): Promise<IGitHelper> {
-  return await GitHelper.create(workingDirectory, lfs)
+  return await GitHelper.create(settings)
 }
 
 export class GitHelper implements IGitHelper {
@@ -215,14 +214,14 @@ export class GitHelper implements IGitHelper {
     return this.gitCommandManager.tagExists(pattern)
   }
 
-  static async create(
-    workingDirectory: string,
-    lfs: boolean
-  ): Promise<IGitHelper> {
-    const gitCommandManager = await createCommandManager(workingDirectory, lfs)
+  static async create(settings: IGitSourceSettings): Promise<IGitHelper> {
+    const gitCommandManager = await createCommandManager(
+      settings.repositoryPath,
+      settings.lfs
+    )
 
     const gitHelper = new GitHelper(gitCommandManager)
-    gitHelper.settings.repositoryPath = workingDirectory
+    gitHelper.settings = settings
 
     return gitHelper
   }

src/php-prefixer-helper.ts

@@ -129,7 +129,7 @@ export class PhpPrefixerHelper {
       await this.targetGitHelper.tag(this.targetPrefixedTag)
     }
 
-    await this.targetGitHelper.push(this.targetPrefixedBranch)
+    await this.targetGitHelper.push('prefixed', this.targetPrefixedBranch)
 
     return true
   }
@@ -190,6 +190,8 @@ export class PhpPrefixerHelper {
       this.targetPath
     )
 
+    this.targetGitHelper.remoteAdd(this.isRemote, 'prefixed')
+
     const branchCreated = await this.targetGitHelper.checkoutToBranch(
       this.isRemote,
       this.targetPrefixedBranch
@@ -221,10 +223,7 @@ export class PhpPrefixerHelper {
     targetGitHelper?: IGitHelper
   ): Promise<PhpPrefixerHelper> {
     if (!sourceGitHelper) {
-      sourceGitHelper = await createGitHelper(
-        sourceSettings.repositoryPath,
-        sourceSettings.lfs
-      )
+      sourceGitHelper = await createGitHelper(sourceSettings)
     }
 
     if (!targetPath) {
@@ -236,7 +235,8 @@ export class PhpPrefixerHelper {
     await fs.promises.access(targetPath, fs.constants.W_OK)
 
     if (!targetGitHelper) {
-      targetGitHelper = await createGitHelper(targetPath, sourceSettings.lfs)
+      const targetSettings = {...sourceSettings, repositoryPath: targetPath}
+      targetGitHelper = await createGitHelper(targetSettings)
     }
 
     const phpPrefixerHelper = new PhpPrefixerHelper(