issue #198: Avoid getting alerts from Code scanning by ivanramosnet · Pull Request #201 · nautilus-cyberneering/git-queue

ivanramosnet · 2022-05-10T19:18:31Z

Fix issue #198

… to helpers.ts file

…f GitRepo class

josecelano · 2022-05-11T08:24:49Z

+    await expect(gitRepo.hasCommits()).resolves.toBe(true)
+  })
+
+  it('should fail when the repo has not been initialized and check if it has commits', async () => {


hi @ivanramosnet I did not understand the test intention well. Maybe it's only me but I would rephrase it to:

it should fail while checking if the repo has commits when it has not been initialized

josecelano · 2022-05-17T09:00:47Z

hi @ivanramosnet can you rebase? There is a failing test because now we need the job id in the commit subject. You only need to add it to this function:

export function dummyCommitSubjectText(): string {
  return '📝🈺: queue-name: job.id.1 job.ref.f1a69d48a01cc130a64aeac5eaf762e4ba685de7'
}

da2ce7 · 2022-05-17T09:44:39Z

    expect(gitRepo.isInitialized()).toBe(true)
  })
+
+  it('should check if a repo has commits', async () => {


Maybe:
initialize new git repository, check that there are no comments, add a test comment, check for the comment

josecelano · 2022-05-17T14:44:02Z

hi, @ivanramosnet I think tests are failing. Tests are not being executed on PR from forks. After you rebase make sure tests pass: yarn test

UPDATE:

Tests only fail if you execute them locally with yarn test without having any committer configuration in your Git configuration. If you remove these lines from your global git config:

[user]
        name = Your Name
        email = Your Email
        signingkey = XXXX

You will see these errors:

Summary of all failing tests
 FAIL  __tests__/e2e/main.test.ts (11.704 s)
  ● GitHub Action › should create a new job

    expect(received).toBe(expected) // Object.is equality

    Expected: "true"
    Received: undefined

      124 |     const output = executeAction(env)
      125 |
    > 126 |     expect(getOutputVariable('job_created', output.toString())).toBe('true')
          |                                                                 ^
      127 |     expect(getOutputVariable('job_commit', output.toString())).toBe(
      128 |       getLatestCommitHash(gitRepo.getDir()).getHash()
      129 |     )

      at __tests__/e2e/main.test.ts:126:65
      at fulfilled (__tests__/e2e/main.test.ts:28:58)

  ● GitHub Action › should get the next job

    expect(received).toBe(expected) // Object.is equality

    Expected: "test"
    Received: undefined

      145 |     const output = executeAction(env)
      146 |
    > 147 |     expect(getOutputVariable('job_payload', output.toString())).toBe(
          |                                                                 ^
      148 |       dummyPayload()
      149 |     )
      150 |     expect(getOutputVariable('job_commit', output.toString())).toBe(

      at __tests__/e2e/main.test.ts:147:65
      at fulfilled (__tests__/e2e/main.test.ts:28:58)

  ● GitHub Action › should mark the pending job as started

    expect(received).toBe(expected) // Object.is equality

    Expected: "true"
    Received: undefined

      169 |     const output = executeAction(env)
      170 |
    > 171 |     expect(getOutputVariable('job_started', output.toString())).toBe('true')
          |                                                                 ^
      172 |     expect(getOutputVariable('job_commit', output.toString())).toBe(
      173 |       getLatestCommitHash(gitRepo.getDir()).getHash()
      174 |     )

      at __tests__/e2e/main.test.ts:171:65
      at fulfilled (__tests__/e2e/main.test.ts:28:58)

  ● GitHub Action › should mark the pending job as finished

    expect(received).toBe(expected) // Object.is equality

    Expected: "true"
    Received: undefined

      198 |     })
      199 |
    > 200 |     expect(getOutputVariable('job_finished', output.toString())).toBe('true')
          |                                                                  ^
      201 |     expect(getOutputVariable('job_commit', output.toString())).toBe(
      202 |       getLatestCommitHash(gitRepo.getDir()).getHash()
      203 |     )

      at __tests__/e2e/main.test.ts:200:66
      at fulfilled (__tests__/e2e/main.test.ts:28:58)

  ● GitHub Action › should allow to overwrite commit signing key

    Command failed: git log --show-signature -n1
    fatal: your current branch 'main' does not have any commits yet

      88 | export function gitLogForLatestCommit(gitRepoDir: string): string {
      89 |   const output = cp
    > 90 |     .execFileSync('git', ['log', '--show-signature', '-n1'], {
         |      ^
      91 |       cwd: gitRepoDir
      92 |     })
      93 |     .toString()

      at gitLogForLatestCommit (src/__tests__/helpers.ts:90:6)
      at __tests__/e2e/main.test.ts:224:47
      at fulfilled (__tests__/e2e/main.test.ts:28:58)

  ● GitHub Action › should allow to disable commit signing for a given commit

    Command failed: git log --show-signature -n1
    fatal: your current branch 'main' does not have any commits yet

      88 | export function gitLogForLatestCommit(gitRepoDir: string): string {
      89 |   const output = cp
    > 90 |     .execFileSync('git', ['log', '--show-signature', '-n1'], {
         |      ^
      91 |       cwd: gitRepoDir
      92 |     })
      93 |     .toString()

      at gitLogForLatestCommit (src/__tests__/helpers.ts:90:6)
      at __tests__/e2e/main.test.ts:243:47
      at fulfilled (__tests__/e2e/main.test.ts:28:58)

  ● GitHub Action › should always overwrite the commit author with: NautilusCyberneering[bot] <bot@nautilus-cyberneering.de>

    Command failed: git log --show-signature -n1
    fatal: your current branch 'main' does not have any commits yet

      88 | export function gitLogForLatestCommit(gitRepoDir: string): string {
      89 |   const output = cp
    > 90 |     .execFileSync('git', ['log', '--show-signature', '-n1'], {
         |      ^
      91 |       cwd: gitRepoDir
      92 |     })
      93 |     .toString()

      at gitLogForLatestCommit (src/__tests__/helpers.ts:90:6)
      at __tests__/e2e/main.test.ts:259:47
      at fulfilled (__tests__/e2e/main.test.ts:28:58)


Test Suites: 1 failed, 20 passed, 21 total
Tests:       7 failed, 117 passed, 124 total

I think this is related to #175. Tests should set up the configuration they need and not rely on preexisting configurations.

josecelano · 2022-06-01T12:45:06Z

Replaced by #235

josecelano · 2022-06-01T16:25:42Z

Merged with #235

ivanramosnet added 4 commits May 10, 2022 20:11

fix: [nautilus-cyberneering#198] Avoid getting alerts from Code scanning

99beeaf

fix: [nautilus-cyberneering#198] Remove unused function

e040672

refactor: [nautilus-cyberneering#198] Move helpers functions for test…

8bc34f1

… to helpers.ts file

test: [nautilus-cyberneering#198] Add tests for hasCommits function o…

f827c41

…f GitRepo class

josecelano approved these changes May 11, 2022

View reviewed changes

da2ce7 reviewed May 17, 2022

View reviewed changes

josecelano mentioned this pull request May 17, 2022

E2e test fail if you do not have the Git configured with the committer info #219

Closed

josecelano linked an issue Jun 1, 2022 that may be closed by this pull request

Fix code scanning alert - Shell command built from environment values #198

Closed

1 task

josecelano mentioned this pull request Jun 1, 2022

Fix code scanning alert #235

Merged

josecelano closed this Jun 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

issue #198: Avoid getting alerts from Code scanning#201

issue #198: Avoid getting alerts from Code scanning#201
ivanramosnet wants to merge 4 commits into
nautilus-cyberneering:mainfrom
ivanramosnet:issue-198-fix-code-scanning-alert

ivanramosnet commented May 10, 2022

Uh oh!

josecelano May 11, 2022

Uh oh!

josecelano commented May 17, 2022

Uh oh!

da2ce7 May 17, 2022

Uh oh!

josecelano commented May 17, 2022 •

edited

Loading

Uh oh!

josecelano commented Jun 1, 2022

Uh oh!

josecelano commented Jun 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ivanramosnet commented May 10, 2022

Uh oh!

josecelano May 11, 2022

Choose a reason for hiding this comment

Uh oh!

josecelano commented May 17, 2022

Uh oh!

da2ce7 May 17, 2022

Choose a reason for hiding this comment

Uh oh!

josecelano commented May 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

josecelano commented Jun 1, 2022

Uh oh!

josecelano commented Jun 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

josecelano commented May 17, 2022 •

edited

Loading