Skip to content

Commit

Permalink
More clarification around Docker and conformance tests
Browse files Browse the repository at this point in the history
  • Loading branch information
jskeet committed Nov 26, 2019
1 parent 3bfa539 commit 198af0a
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 3 deletions.
6 changes: 3 additions & 3 deletions ENVIRONMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ for those scripts.

Installing some of the dependencies can be tricky, particularly on
restricted internal versions of Linux. For that reason, we provide a
[Dockerfile](docker/Dockerfile) to get started with. The typical
procedure would be:
[Dockerfile](docker/Dockerfile) to get started with, which has
`bash` as an entry point. The typical procedure would be:

- `git clone https://github.com/googleapis/google-cloud-dotnet.git`
- `git clone --recursive https://github.com/googleapis/google-cloud-dotnet.git`
- `cd google-cloud-dotnet`
- `docker build -t google-cloud-dotnet docker`
- `docker run -v $PWD:/google-cloud-dotnet -it google-cloud-dotnet`
Expand Down
18 changes: 18 additions & 0 deletions TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,24 @@ be a bug in a test which wipes all the data in the project. It is
*very strongly* recommended that you only run tests against projects
which do not contain any production data or services.

Initializing conformance test data
==================================

Cross-language conformance tests are defined in a [separate
repository](https://github.com/googleapis/conformance-tests) which
is referenced as a submodule within the google-cloud-dotnet
repository.

To ensure the submodule is suitably initialized and updated (so that
the conformance test data is available locally) run this command:

```sh
git submodule update --init
```

(If your local `conformance-tests` directory contains files including a
`README.md`, that probably means all is well.)

Running tests via scripts
=========================

Expand Down
11 changes: 11 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Please see [ENVIRONMENT.md](../ENVIRONMENT.md) for details about
this Dockerfile. The short version is:

- It's intended to make it easy to perform builds, tests, releases
etc under Linux without modifying your local system.
- It has an entry point of `bash` already
- It expects `/google-cloud-dotnet` (in the container) to be a shared volume mount
using a clone of this repository.
- Run the following commands from the repository root:
- `docker build -t google-cloud-dotnet docker`
- `docker run -v $PWD:/google-cloud-dotnet -it google-cloud-dotnet`

0 comments on commit 198af0a

Please sign in to comment.