Giant blob of minor changes
[dotfiles/.git] / .config / coc / extensions / coc-go-data / tools / pkg / mod / golang.org / x / tools / gopls@v0.5.2 / integration / govim / README.md
1 # govim integration tests
2
3 Files in this directory configure Cloud Build to run [govim] integration tests
4 against a gopls binary built from source.
5
6 ## Running on GCP
7
8 To run these integration tests in Cloud Build, use the following steps.  Here
9 we assume that `$PROJECT_ID` is a valid GCP project and `$BUCKET` is a cloud
10 storage bucket owned by that project.
11
12 - `cd` to the root directory of the tools project.
13 - (at least once per GCP project) Build the test harness:
14 ```
15 $ gcloud builds submit \
16         --project="${PROJECT_ID}" \
17         --config=gopls/integration/govim/cloudbuild.harness.yaml
18 ```
19 - Run the integration tests:
20 ```
21 $ gcloud builds submit \
22         --project="${PROJECT_ID}" \
23         --config=gopls/integration/govim/cloudbuild.yaml \
24         --substitutions=_RESULT_BUCKET="${BUCKET}"
25 ```
26
27 ## Fetching Artifacts
28
29 Assuming the artifacts bucket is world readable, you can fetch integration from
30 GCS. They are located at:
31
32 - logs: `https://storage.googleapis.com/${BUCKET}/log-${EVALUATION_ID}.txt`
33 - artifact tarball: `https://storage.googleapis.com/${BUCKET}/govim/${EVALUATION_ID}/artifacts.tar.gz`
34
35 The `artifacts.go` command can be used to fetch both artifacts using an
36 evaluation id.
37
38 ## Running locally
39
40 Run `gopls/integration/govim/run_local.sh`. This may take a while the first
41 time it is run, as it will require building the test harness. This script
42 accepts two flags to modify its behavior:
43
44 **--sudo**: run docker with `sudo`
45 **--short**: run `go test -short`
46
47 [govim]: https://github.com/govim/govim