Skip to content

Commit 26e57c9

Browse files
authored
Clean-up readme for Mint (#97)
1 parent 0bba657 commit 26e57c9

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Collection of tests to detect overall correctness of Minio server.
99

1010
## Roadmap
1111

12-
- Minio-SDK functional tests are pulled from respective SDKs and tested.
12+
- `minio-js`, `minio-go`, `minio-dotnet` functional tests are pulled from respective SDKs instead of local test copy in Mint repo. `minio-py` & `minio-java` tests are already pulled from respective SDKs.
1313
- Add test cases under categories like correctness, stress/load, etc.
1414
- Add specific tests for distributed mode, shared-backend mode, gateway mode
1515
- Add other SDK/Client side tools to increase the test case variety
@@ -41,7 +41,7 @@ $ docker run -e SERVER_ENDPOINT=play.minio.io:9000 -e ACCESS_KEY=Q3AM3UQ867SPQQA
4141
After the tests are run, output is stored in `/mint/log` directory inside the container. You can access these logs via `docker cp` command. For example to store logs to `/tmp/logs` directory on your host, run
4242

4343
```sh
44-
docker cp minio/mint:/mint/log /tmp/logs
44+
docker cp <container-id>:/mint/log /tmp/logs
4545
```
4646

4747
Then navigate to `/tmp/logs` directory to access the test logs.
@@ -63,15 +63,13 @@ Following SDKs/CLI tools are available:
6363

6464
To add tests to an existing SDK folder:
6565

66-
- Navigate to specific SDK test file in the path `apps/<sdk_name>/`.
67-
- Add test cases and update `main` method if applicable.
68-
- Refer test data section for using existing test data.
66+
- Add tests to respective SDK repository functional test.
6967

70-
To add new SDK/CLI to Mint:
68+
To add new SDK/CLI tool to Mint:
7169

72-
- Create new directory in `apps/` directory with corresponding tool name
70+
- Check if the environment for the programming language is already set in `build` directory, if not, add a new directory for the language and add set up steps (including SDK/CLI tool) in `install.sh` directory.
71+
- Create new directory in `run/core/<sdk_name>` directory with corresponding tool name.
7372
- Add a `run.sh` script. This script should set up the SDK/CLI tool and then execute the tests
74-
- Add an entry in `config.yaml` with name of folder, e.g test_folder
7573

7674
## Building Mint Docker image
7775

@@ -80,7 +78,7 @@ To add new SDK/CLI to Mint:
8078
```sh
8179
$ git clone https://github.com/minio/mint.git
8280
$ cd mint
83-
$ docker build -t minio/mint .
81+
$ docker build -t minio/mint . -f Dockerfile.dev
8482
```
8583

8684
Developers can also customize `Dockerfile.dev` to generate smaller build images. For example, removing the following lines from `Dockerfile.dev` will avoid shipping Golang SDK tests in the image hence a faster build and tests execution time.
@@ -92,7 +90,7 @@ RUN /mint/build/go/install.sh
9290

9391
### Build using Travis
9492

95-
Each pull request when submitted to Github `travis-ci` runs build on mint to create new docker image on `play.minio.io`, our private docker registry. You can get the `mint` image associated with your pull request by just running `docker pull play.minio.io/mint:$PULL_REQUEST_SHA`
93+
Each pull request when submitted to Github `travis-ci` runs build on mint to create new docker image on `play.minio.io`, our private docker registry. You can get the `mint` image associated with your pull request by just running `docker pull play.minio.io/mint:$PULL_REQUEST_SHA`. For example
9694

9795
```sh
9896
$ docker pull play.minio.io/mint:travis-f9f519cefc25f2eeb210847e782a47e466a6b79e

0 commit comments

Comments
 (0)