-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
68 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| [1mdiff --git a/README.md b/README.md[m | ||
| [1mindex 24af29d..d544c1d 100644[m | ||
| [1m--- a/README.md[m | ||
| [1m+++ b/README.md[m | ||
| [36m@@ -9,7 +9,7 @@[m [mCollection of tests to detect overall correctness of Minio server.[m | ||
| [m | ||
| ## Roadmap[m | ||
| [m | ||
| [31m-- Minio-SDK functional tests are pulled from respective SDKs and tested.[m | ||
| [32m+[m[32m- `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.[m | ||
| - Add test cases under categories like correctness, stress/load, etc.[m | ||
| - Add specific tests for distributed mode, shared-backend mode, gateway mode[m | ||
| - Add other SDK/Client side tools to increase the test case variety[m | ||
| [36m@@ -41,7 +41,7 @@[m [m$ docker run -e SERVER_ENDPOINT=play.minio.io:9000 -e ACCESS_KEY=Q3AM3UQ867SPQQA[m | ||
| 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[m | ||
| [m | ||
| ```sh[m | ||
| [31m-docker cp minio/mint:/mint/log /tmp/logs[m | ||
| [32m+[m[32mdocker cp <container-id>:/mint/log /tmp/logs[m | ||
| ```[m | ||
| [m | ||
| Then navigate to `/tmp/logs` directory to access the test logs.[m | ||
| [36m@@ -63,15 +63,13 @@[m [mFollowing SDKs/CLI tools are available:[m | ||
| [m | ||
| To add tests to an existing SDK folder:[m | ||
| [m | ||
| [31m-- Navigate to specific SDK test file in the path `apps/<sdk_name>/`.[m | ||
| [31m-- Add test cases and update `main` method if applicable.[m | ||
| [31m-- Refer test data section for using existing test data.[m | ||
| [32m+[m[32m- Add tests to respective SDK repository functional test.[m | ||
| [m | ||
| [31m-To add new SDK/CLI to Mint:[m | ||
| [32m+[m[32mTo add new SDK/CLI tool to Mint:[m | ||
| [m | ||
| [31m-- Create new directory in `apps/` directory with corresponding tool name[m | ||
| [32m+[m[32m- 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.[m | ||
| [32m+[m[32m- Create new directory in `run/core/<sdk_name>` directory with corresponding tool name.[m | ||
| - Add a `run.sh` script. This script should set up the SDK/CLI tool and then execute the tests[m | ||
| [31m-- Add an entry in `config.yaml` with name of folder, e.g test_folder[m | ||
| [m | ||
| ## Building Mint Docker image[m | ||
| [m | ||
| [36m@@ -80,7 +78,7 @@[m [mTo add new SDK/CLI to Mint:[m | ||
| ```sh[m | ||
| $ git clone https://github.com/minio/mint.git[m | ||
| $ cd mint[m | ||
| [31m-$ docker build -t minio/mint .[m | ||
| [32m+[m[32m$ docker build -t minio/mint . -f Dockerfile.dev[m | ||
| ```[m | ||
| [m | ||
| 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.[m | ||
| [36m@@ -92,7 +90,7 @@[m [mRUN /mint/build/go/install.sh[m | ||
| [m | ||
| ### Build using Travis[m | ||
| [m | ||
| [31m-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`[m | ||
| [32m+[m[32mEach 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[m | ||
| [m | ||
| ```sh[m | ||
| $ docker pull play.minio.io/mint:travis-f9f519cefc25f2eeb210847e782a47e466a6b79e[m |