qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 19:34:41 -07:00
Code Releases Activity
9a0fabac01
go/gopls/integration/govim/README.md

46 lines
1.5 KiB
Markdown
Raw Normal View History

gopls/integration: add a first cut of govim integration tests Govim has integration tests that we can leverage to help guard gopls against regressions. Changes have been submitted upstream to facilitate running these tests against a locally built gopls binary (https://github.com/govim/govim/pull/629) This CL adds a Dockerfile to build an image that has a version of govim available and ready for testing. This is then used to create a custom build step in a separate Cloud Build configuration, that builds gopls from source and runs the govim integration tests. A script (run_local.sh) is also added to facilitate running these tests locally. Change-Id: If68eabf9863a1689e29d9d744ff953d94a2b7681 Reviewed-on: https://go-review.googlesource.com/c/tools/+/212018 Reviewed-by: Paul Jolly <paul@myitcv.org.uk> Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2019-12-18 12:55:07 -07:00
# govim integration tests
Files in this directory configure Cloud Build to run [govim] integration tests
against a gopls binary built from source.
## Running on GCP
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
To run these integration tests in Cloud Build, use the following steps. Here
gopls/integration/govim: switch to latest, and improve artifacts Now that there is a tagged version of govim containing the `-gopls` test flag, we can just use latest to pick up a relatively stable govim, and not have to maintain the govim version. Doing this required changing the way we fetch govim into our test harness: there is now the assumption that /src/govim is a git repository, so we clone using git. Along the way, clean up some unnecessary artifacts and add a script for downloading artifacts from GCS. Change-Id: I6ef4dd468d6b9baf66d3adae3f1fb80c12ac9578 Reviewed-on: https://go-review.googlesource.com/c/tools/+/217730 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-02-04 18:14:12 -07:00
we assume that `$PROJECT_ID` is a valid GCP project and `$BUCKET` is a cloud
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
storage bucket owned by that project.
gopls/integration: add a first cut of govim integration tests Govim has integration tests that we can leverage to help guard gopls against regressions. Changes have been submitted upstream to facilitate running these tests against a locally built gopls binary (https://github.com/govim/govim/pull/629) This CL adds a Dockerfile to build an image that has a version of govim available and ready for testing. This is then used to create a custom build step in a separate Cloud Build configuration, that builds gopls from source and runs the govim integration tests. A script (run_local.sh) is also added to facilitate running these tests locally. Change-Id: If68eabf9863a1689e29d9d744ff953d94a2b7681 Reviewed-on: https://go-review.googlesource.com/c/tools/+/212018 Reviewed-by: Paul Jolly <paul@myitcv.org.uk> Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2019-12-18 12:55:07 -07:00
- `cd` to the root directory of the tools project.
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
- (at least once per GCP project) Build the test harness:
gopls/integration: add a first cut of govim integration tests Govim has integration tests that we can leverage to help guard gopls against regressions. Changes have been submitted upstream to facilitate running these tests against a locally built gopls binary (https://github.com/govim/govim/pull/629) This CL adds a Dockerfile to build an image that has a version of govim available and ready for testing. This is then used to create a custom build step in a separate Cloud Build configuration, that builds gopls from source and runs the govim integration tests. A script (run_local.sh) is also added to facilitate running these tests locally. Change-Id: If68eabf9863a1689e29d9d744ff953d94a2b7681 Reviewed-on: https://go-review.googlesource.com/c/tools/+/212018 Reviewed-by: Paul Jolly <paul@myitcv.org.uk> Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2019-12-18 12:55:07 -07:00
```
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
$ gcloud builds submit \
gopls/integration/govim: switch to latest, and improve artifacts Now that there is a tagged version of govim containing the `-gopls` test flag, we can just use latest to pick up a relatively stable govim, and not have to maintain the govim version. Doing this required changing the way we fetch govim into our test harness: there is now the assumption that /src/govim is a git repository, so we clone using git. Along the way, clean up some unnecessary artifacts and add a script for downloading artifacts from GCS. Change-Id: I6ef4dd468d6b9baf66d3adae3f1fb80c12ac9578 Reviewed-on: https://go-review.googlesource.com/c/tools/+/217730 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-02-04 18:14:12 -07:00
--project="${PROJECT_ID}" \
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
--config=gopls/integration/govim/cloudbuild.harness.yaml \
--substitutions=_RESULT_BUCKET="${BUCKET}"
gopls/integration: add a first cut of govim integration tests Govim has integration tests that we can leverage to help guard gopls against regressions. Changes have been submitted upstream to facilitate running these tests against a locally built gopls binary (https://github.com/govim/govim/pull/629) This CL adds a Dockerfile to build an image that has a version of govim available and ready for testing. This is then used to create a custom build step in a separate Cloud Build configuration, that builds gopls from source and runs the govim integration tests. A script (run_local.sh) is also added to facilitate running these tests locally. Change-Id: If68eabf9863a1689e29d9d744ff953d94a2b7681 Reviewed-on: https://go-review.googlesource.com/c/tools/+/212018 Reviewed-by: Paul Jolly <paul@myitcv.org.uk> Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2019-12-18 12:55:07 -07:00
```
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
- Run the integration tests:
gopls/integration: add a first cut of govim integration tests Govim has integration tests that we can leverage to help guard gopls against regressions. Changes have been submitted upstream to facilitate running these tests against a locally built gopls binary (https://github.com/govim/govim/pull/629) This CL adds a Dockerfile to build an image that has a version of govim available and ready for testing. This is then used to create a custom build step in a separate Cloud Build configuration, that builds gopls from source and runs the govim integration tests. A script (run_local.sh) is also added to facilitate running these tests locally. Change-Id: If68eabf9863a1689e29d9d744ff953d94a2b7681 Reviewed-on: https://go-review.googlesource.com/c/tools/+/212018 Reviewed-by: Paul Jolly <paul@myitcv.org.uk> Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2019-12-18 12:55:07 -07:00
```
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
$ gcloud builds submit \
gopls/integration/govim: switch to latest, and improve artifacts Now that there is a tagged version of govim containing the `-gopls` test flag, we can just use latest to pick up a relatively stable govim, and not have to maintain the govim version. Doing this required changing the way we fetch govim into our test harness: there is now the assumption that /src/govim is a git repository, so we clone using git. Along the way, clean up some unnecessary artifacts and add a script for downloading artifacts from GCS. Change-Id: I6ef4dd468d6b9baf66d3adae3f1fb80c12ac9578 Reviewed-on: https://go-review.googlesource.com/c/tools/+/217730 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-02-04 18:14:12 -07:00
--project="${PROJECT_ID}" \
gopls/integration/govim: update build steps to capture artifacts Govim integration tests generate a number of artifacts, including both the govim and gopls logs, that can be useful in debugging failures. This change updates our cloud build configuration to capture these artifacts, along with several other minor improvements. Notably artifacts are uploaded to GCS as a separate build step, so that we have the potential to use its granular permission model for sharing these artifacts. Right now, this requires temporarily swallowing the exit code of `go test` so that the build can proceed. Also: - Update govim to a newer version; we still can't use latest as there isn't a tagged version that contains the requisite flag change. - Alter the test harness to run tests from the github.com/govim/govim module root. - Switch use a major version label when referring to the test harness build step, to allow for breaking changes (such as the one made here). - Add a missing copyright header to run_local.sh. - Update run_local.sh to work with the modified harness. - Update documentation accordingly. Change-Id: Ie5ddaf54e775371a36163f98c1beb90c217be931 Reviewed-on: https://go-review.googlesource.com/c/tools/+/214577 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-01-13 13:22:19 -07:00
--config=gopls/integration/govim/cloudbuild.yaml \
--substitutions=_RESULT_BUCKET="${BUCKET}"
gopls/integration: add a first cut of govim integration tests Govim has integration tests that we can leverage to help guard gopls against regressions. Changes have been submitted upstream to facilitate running these tests against a locally built gopls binary (https://github.com/govim/govim/pull/629) This CL adds a Dockerfile to build an image that has a version of govim available and ready for testing. This is then used to create a custom build step in a separate Cloud Build configuration, that builds gopls from source and runs the govim integration tests. A script (run_local.sh) is also added to facilitate running these tests locally. Change-Id: If68eabf9863a1689e29d9d744ff953d94a2b7681 Reviewed-on: https://go-review.googlesource.com/c/tools/+/212018 Reviewed-by: Paul Jolly <paul@myitcv.org.uk> Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2019-12-18 12:55:07 -07:00
```
gopls/integration/govim: switch to latest, and improve artifacts Now that there is a tagged version of govim containing the `-gopls` test flag, we can just use latest to pick up a relatively stable govim, and not have to maintain the govim version. Doing this required changing the way we fetch govim into our test harness: there is now the assumption that /src/govim is a git repository, so we clone using git. Along the way, clean up some unnecessary artifacts and add a script for downloading artifacts from GCS. Change-Id: I6ef4dd468d6b9baf66d3adae3f1fb80c12ac9578 Reviewed-on: https://go-review.googlesource.com/c/tools/+/217730 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-02-04 18:14:12 -07:00
## Fetching Artifacts
Assuming the artifacts bucket is world readable, you can fetch integration from
GCS. They are located at:
- logs: `https://storage.googleapis.com/${BUCKET}/log-${EVALUATION_ID}.txt`
- artifact tarball: `https://storage.googleapis.com/${BUCKET}/govim/${EVALUATION_ID}/artifacts.tar.gz`
The `artifacts.go` command can be used to fetch both artifacts using an
evaluation id.
gopls/integration: add a first cut of govim integration tests Govim has integration tests that we can leverage to help guard gopls against regressions. Changes have been submitted upstream to facilitate running these tests against a locally built gopls binary (https://github.com/govim/govim/pull/629) This CL adds a Dockerfile to build an image that has a version of govim available and ready for testing. This is then used to create a custom build step in a separate Cloud Build configuration, that builds gopls from source and runs the govim integration tests. A script (run_local.sh) is also added to facilitate running these tests locally. Change-Id: If68eabf9863a1689e29d9d744ff953d94a2b7681 Reviewed-on: https://go-review.googlesource.com/c/tools/+/212018 Reviewed-by: Paul Jolly <paul@myitcv.org.uk> Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2019-12-18 12:55:07 -07:00
## Running locally
Run `gopls/integration/govim/run_local.sh`. This may take a while the first
time it is run, as it will require building the test harness. Currently this
script assumes that docker may be executed without `sudo`.
[govim]: https://github.com/govim/govim
Copy Permalink