Merge #293

293: Improve Docker configuration in the package r=bidoubiwa a=meili-bot

_This PR is auto-generated._

Add a basic Docker configuration based on this [integration-guides issue](meilisearch/integration-guides#199). 


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Charlotte Vermandel <[email protected]>
Co-authored-by: Bruno Casali <[email protected]>

Author: 4 people

CONTRIBUTING.md

@@ -27,6 +27,19 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
 
 ## Development Workflow
 
+You can set up your local environment natively or using `docker`, check out the [`docker-compose.yml`](/docker-compose.yml).
+
+Example of running all the checks with docker:
+```bash
+docker-compose run --rm package bash -c "cargo test"
+```
+
+To install dependencies:
+
+```bash
+cargo build --release
+```
+
 ### Tests <!-- omit in toc -->
 
 To run the tests, run:

README.md

@@ -102,7 +102,7 @@ struct Movie {
 
 fn main() { block_on(async move {
     // Create a client (without sending any request so that can't fail)
-    let client = Client::new("http://localhost:7700", "masterKey");
+    let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
 
     // An index is where the documents are stored.
     let movies = client.index("movies");

docker-compose.yml

@@ -0,0 +1,31 @@
+version: "3.8"
+
+# remove this line if you don't need a volume to map your dependencies
+# Check how to cache the build
+volumes:
+  cargo:
+
+services:
+  package:
+    image: rust:1
+    tty: true
+    stdin_open: true
+    working_dir: /home/package
+    environment:
+      - MEILISEARCH_HOST=http://meilisearch:7700
+      - CARGO_HOME=/vendor/cargo
+    depends_on:
+      - meilisearch
+    links:
+      - meilisearch
+    volumes:
+      - ./:/home/package
+      - cargo:/vendor/cargo
+
+  meilisearch:
+    image: getmeili/meilisearch:latest
+    ports:
+      - "7700"
+    environment:
+      - MEILI_MASTER_KEY=masterKey
+      - MEILI_NO_ANALYTICS=true

meilisearch-test-macro/README.md

@@ -13,7 +13,7 @@ Before explaining its usage, we're going to see a simple test *before* this macr
 ```rust
 #[async_test]
 async fn test_get_tasks() -> Result<(), Error> {
-  let client = Client::new("http://localhost:7700", "masterKey");
+  let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
 
   let index = client
     .create_index("test_get_tasks", None)
@@ -36,7 +36,7 @@ async fn test_get_tasks() -> Result<(), Error> {
 ```
 
 I have multiple problems with this test:
-- `let client = Client::new("http://localhost:7700", "masterKey");`: This line is always the same in every test.
+- `let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);`: This line is always the same in every test.
   And if you make a typo on the http addr or the master key, you'll have an error.
 - `let index = client.create_index("test_get_tasks", None)...`: Each test needs to have an unique name.
   This means we currently need to write the name of the test everywhere; it's not practical.

meilisearch-test-macro/src/lib.rs

@@ -83,7 +83,13 @@ pub fn meilisearch_test(params: TokenStream, input: TokenStream) -> TokenStream
         // First we need to check if a client will be used and create it if it’s the case
         if use_client {
             outer_block.push(parse_quote!(
-                let client = Client::new("http://localhost:7700", "masterKey");
+                let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
+            ));
+            outer_block.push(parse_quote!(
+                let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+            ));
+            outer_block.push(parse_quote!(
+                let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
             ));
         }