issue #198: Avoid getting alerts from Code scanning

__tests__/unit/git-repo.test.ts

@@ -1,8 +1,15 @@
 import {
+  commitOptionsForTests,
   createTempEmptyDir,
+  dummyCommitBodyText,
+  dummyCommitSubjectText,
   newSimpleGitWithCommitterIdentity
 } from '../../src/__tests__/helpers'
 
+import {CommitBody} from '../../src/commit-body'
+import {CommitMessage} from '../../src/commit-message'
+import {CommitSubjectParser} from '../../src/commit-subject-parser'
+import {GitDirNotInitializedError} from '../../src/errors'
 import {GitRepo} from '../../src/git-repo'
 import {GitRepoDir} from '../../src/git-repo-dir'
 
@@ -37,4 +44,33 @@ describe('GitRepo', () => {
 
     expect(gitRepo.isInitialized()).toBe(true)
   })
+
+  it('should check if a repo has commits', async () => {
+    const gitRepoDir = new GitRepoDir(await createTempEmptyDir())
+    const git = await newSimpleGitWithCommitterIdentity(gitRepoDir)
+    const gitRepo = new GitRepo(gitRepoDir, git)
+
+    await gitRepo.init()
+
+    const subject = CommitSubjectParser.parseText(dummyCommitSubjectText())
+    const body = new CommitBody(dummyCommitBodyText())
+
+    const commitMessage = new CommitMessage(subject, body)
+
+    await expect(gitRepo.hasCommits()).resolves.toBe(false)
+
+    await gitRepo.commit(commitMessage, commitOptionsForTests())
+
+    await expect(gitRepo.hasCommits()).resolves.toBe(true)
+  })
+
+  it('should fail when the repo has not been initialized and check if it has commits', async () => {
+    const gitRepoDir = new GitRepoDir(await createTempEmptyDir())
+    const git = await newSimpleGitWithCommitterIdentity(gitRepoDir)
+    const gitRepo = new GitRepo(gitRepoDir, git)
+
+    await expect(gitRepo.hasCommits()).rejects.toThrow(
+      GitDirNotInitializedError
+    )
+  })
 })

__tests__/unit/queue.test.ts

@@ -1,4 +1,6 @@
 import {
+  commitOptionsForTests,
+  commitOptionsForTestsUsingSignature,
   createInitializedGitRepo,
   createInitializedTempGnuPGHomeDir,
   createNotInitializedGitRepo,
@@ -8,39 +10,15 @@ import {
   gitLogForLatestCommit
 } from '../../src/__tests__/helpers'
 
-import {CommitAuthor} from '../../src/commit-author'
 import {CommitInfo} from '../../src/commit-info'
 import {CommitOptions} from '../../src/commit-options'
 import {GitRepo} from '../../src/git-repo'
 import {Job} from '../../src/job'
 import {Queue} from '../../src/queue'
 import {QueueName} from '../../src/queue-name'
-import {SigningKeyId} from '../../src/signing-key-id'
 
 import {testConfiguration} from '../../src/__tests__/config'
 
-function commitOptionsForTests(): CommitOptions {
-  const author = CommitAuthor.fromNameAndEmail(
-    'A committer',
-    'committer@example.com'
-  )
-  const signingKeyId = new SigningKeyId('')
-  const noGpgSig = true
-  return new CommitOptions(author, signingKeyId, noGpgSig)
-}
-
-function commitOptionsForTestsUsingSignature(): CommitOptions {
-  const author = CommitAuthor.fromNameAndEmail(
-    'A committer',
-    'committer@example.com'
-  )
-  const signingKeyId = new SigningKeyId(
-    testConfiguration().gpg_signing_key.fingerprint
-  )
-  const noGpgSig = false
-  return new CommitOptions(author, signingKeyId, noGpgSig)
-}
-
 async function createTestQueue(
   commitOptions: CommitOptions,
   queueName = 'queue-name'

src/__tests__/helpers.ts

@@ -4,9 +4,12 @@ import * as openpgp from './openpgp'
 
 import simpleGit, {SimpleGit, SimpleGitOptions} from 'simple-git'
 
+import {CommitAuthor} from '../commit-author'
 import {CommitHash} from '../commit-hash'
+import {CommitOptions} from '../commit-options'
 import {GitRepo} from '../git-repo'
 import {GitRepoDir} from '../git-repo-dir'
+import {SigningKeyId} from '../signing-key-id'
 
 import {createTempDir} from 'jest-fixtures'
 import {join} from 'path'
@@ -125,3 +128,29 @@ export function dummyCommitBodyText(): string {
     }
   })
 }
+
+export function dummyCommitSubjectText(): string {
+  return '📝🈺: queue-name: job.ref.f1a69d48a01cc130a64aeac5eaf762e4ba685de7'
+}
+
+export function commitOptionsForTests(): CommitOptions {
+  const author = CommitAuthor.fromNameAndEmail(
+    'A committer',
+    'committer@example.com'
+  )
+  const signingKeyId = new SigningKeyId('')
+  const noGpgSig = true
+  return new CommitOptions(author, signingKeyId, noGpgSig)
+}
+
+export function commitOptionsForTestsUsingSignature(): CommitOptions {
+  const author = CommitAuthor.fromNameAndEmail(
+    'A committer',
+    'committer@example.com'
+  )
+  const signingKeyId = new SigningKeyId(
+    testConfiguration().gpg_signing_key.fingerprint
+  )
+  const noGpgSig = false
+  return new CommitOptions(author, signingKeyId, noGpgSig)
+}

src/git-repo.ts

@@ -41,11 +41,6 @@ export class GitRepo {
     this.git.env(name, value)
   }
 
-  async getCurrentBranch(): Promise<string | null> {
-    const status = await this.git.status()
-    return status.current
-  }
-
   async log(): Promise<LogResult<DefaultLogFields>> {
     return await this.git.log()
   }