Skip to content

Conversation

octref
Copy link
Contributor

@octref octref commented May 24, 2019

See context at microsoft/vscode#71048.

@joaomoreno Please take a look at the release notes, testing/CI docs and see if it makes sense for you. I think it looks simpler.

@joaomoreno
Copy link
Member

Adding @bpasero for review, since he was the original author of this.

@joaomoreno joaomoreno assigned octref and unassigned joaomoreno May 24, 2019
@bpasero bpasero added this to the May 2019 milestone May 24, 2019
| `CODE_LOCALE` | Display language to use when running the tests (default is English) |
| `CODE_DISABLE_EXTENSIONS` | Disable all other extensions except the one that is being tested |
| `CODE_TESTS_DATA_DIR` | Allows to specify the user-data-dir for the tests to use and thus enables to run multiple tests at the same time |
Extension tests can be run on CI services. The `vscode-test` repository itself contains a sample extension that is tested on Azure Devops Pipelines. You can check out the [build pipeline](https://dev.azure.com/vscode/VSCode/_build?definitionId=14) or jump directly to the [build definition yaml file](https://github.com/microsoft/vscode-test/blob/master/azure-pipelines.yml).
Copy link
Member

Choose a reason for hiding this comment

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

I've created a different public Azure DevOps project for this: https://dev.azure.com/vscode/vscode-test. Let's move the microsoft.vscode-test pipeline out of the VSCode project.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't seem to have permission

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here's what I get:

image

Copy link
Member

Choose a reason for hiding this comment

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

Updated. Give it another try.

Copy link
Member

@bpasero bpasero left a comment

Choose a reason for hiding this comment

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

@octref I am a little bit confused about the impact of this change. I assume that yo code will still setup everything needed to run integration tests for the extension, so in most cases a user will not have to deal with vscode-test directly, unless maybe certain parameters are being changed. Under the hood, the generator will configure and use vscode-test accordingly.

If that assumption holds true, then I think the Overview section of Testing Extension should call that out very explicitly and provide a guide how to run extension tests when using having a generated extension. I think you are currently linking to the "Getting Started" section for extensions, but that one as far as I can tell does not mention running tests at all.

As such, I would split the document testing-extensions.md up into a basic and maybe advanced section. Does that make sense?

@octref
Copy link
Contributor Author

octref commented May 28, 2019

assume that yo code will still setup everything needed to run integration tests for the extension, so in most cases a user will not have to deal with vscode-test directly

Good point. I realized most people would either use yo code or clone the sample instead of doing the manual setup, so I:

  • Added a paragraph to explain how to run integration test from yo code output
  • Modified the rest of the document from "here's how you setup your own test script & test runner" to "here's the explanation of test script & test runner in the context of helloworld-test-sample".

@octref octref merged commit 5812632 into vnext May 28, 2019
@joaomoreno joaomoreno deleted the octref/vscode-test branch May 28, 2019 06:45
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.

4 participants