Skip to content

Fail fast if codeql repo is missing from the workspace#1400

Merged
elenatanasoiu merged 2 commits intomainfrom
elenatanasoiu/check-for-codeql-folder-in-workspace
Jun 23, 2022
Merged

Fail fast if codeql repo is missing from the workspace#1400
elenatanasoiu merged 2 commits intomainfrom
elenatanasoiu/check-for-codeql-folder-in-workspace

Conversation

@elenatanasoiu
Copy link
Copy Markdown
Contributor

@elenatanasoiu elenatanasoiu commented Jun 22, 2022

In order to run our cli-integration tests, we're required to have a
local copy of the github/codeql repo. We can then run the tests by
running the Launch Integration Tests - With CLI task from inside
VS Code.

(See CONTRIBUTING.md for details.)

If we don't have the repo cloned locally or we're not pointing to it
in launch.json, we don't get a clear indication of what the problem is.

The tests will still attempt to run.

Let's fail fast instead and add an actionable error message to the output.

Screenshot 2022-06-22 at 19 24 13

We're also updating CONTRIBUTING.md to make it a bit friendlier for
newcomers.

@elenatanasoiu elenatanasoiu requested a review from a team as a code owner June 22, 2022 18:40
@elenatanasoiu elenatanasoiu requested review from a team and aeisenberg June 22, 2022 18:41
Copy link
Copy Markdown
Contributor

@adityasharad adityasharad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Minor clarification: the codeql repo provides the CodeQL libraries, not the CLI.

Comment thread CONTRIBUTING.md Outdated
Comment thread extensions/ql-vscode/src/vscode-tests/cli-integration/global.helper.ts Outdated
@elenatanasoiu elenatanasoiu changed the title Fail fast if codeql CLI is missing from the workspace Fail fast if codeql repo is missing from the workspace Jun 22, 2022
@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/check-for-codeql-folder-in-workspace branch from 245c902 to ac5e906 Compare June 22, 2022 18:53
Comment thread CONTRIBUTING.md Outdated
@elenatanasoiu
Copy link
Copy Markdown
Contributor Author

elenatanasoiu commented Jun 22, 2022

Thanks for reviewing @adityasharad & @aeisenberg 💐

@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/check-for-codeql-folder-in-workspace branch from ac5e906 to 0489537 Compare June 22, 2022 18:56
In order to run our cli-integration tests, we're required to have a
local copy of the codeql CLI repo. We can then run the tests by running
the `Launch Integration Tests - With CLI` task from inside VS Code.

(See CONTRIBUTING.md for details.)

If we don't have the CLI repo cloned locally or we're not pointing to it
in `launch.json`, we don't get a clear indication of what the problem is.

The tests will still attempt to run.

Let's fail fast instead and add an actionable error message to the output.
@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/check-for-codeql-folder-in-workspace branch from 0489537 to e0b2aa9 Compare June 23, 2022 08:13
@elenatanasoiu elenatanasoiu merged commit b7489d8 into main Jun 23, 2022
@elenatanasoiu elenatanasoiu deleted the elenatanasoiu/check-for-codeql-folder-in-workspace branch June 23, 2022 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants