@@ -13,7 +13,7 @@ Make sure to take a look at the project's [style guide](STYLE.md).
13
13
- [ Getting Started] ( #getting-started )
14
14
- [ Debugging mirrord] ( #debugging-mirrord )
15
15
- [ New Hook Guidelines] ( #new-hook-guidelines )
16
- - [ Compiling on MacOs] ( #compliling -on-macos )
16
+ - [ Compiling on MacOs] ( #compiling -on-macos )
17
17
- [ Adding new target types] ( #adding-new-target-types )
18
18
- [ Testing the release workflow] ( #testing-the-release-workflow )
19
19
- [ Architecture] ( #architecture )
@@ -27,7 +27,7 @@ The following guide details the steps to setup a local development environment f
27
27
- [ GCC] ( https://gcc.gnu.org/ ) - only on Linux, GCC is needed for Go dynamic linking
28
28
- [ Rust] ( https://www.rust-lang.org/ )
29
29
- [ NodeJS] ( https://nodejs.org/en/ ) , [ ExpressJS] ( https://expressjs.com/ )
30
- - [ Python] ( https://www.python.org/ ) , [ Flask] ( https://flask.palletsprojects.com/en/2.1.x/ ) , [ FastAPI] ( https://fastapi.tiangolo.com/ )
30
+ - [ Python] ( https://www.python.org/ ) , [ Flask] ( https://flask.palletsprojects.com/en/2.1.x/ ) , [ FastAPI] ( https://fastapi.tiangolo.com/ ) , [ Uvicorn ] ( https://www.uvicorn.org/ )
31
31
- [ Go] ( https://go.dev/ )
32
32
- Kubernetes Cluster (local/remote)
33
33
@@ -94,6 +94,12 @@ with the mirrord CLI. The mirrord CLI spawns an agent for the target on the clus
94
94
layer injected into it. Some test apps need to be compiled before they can be used in the tests
95
95
([ this should be automated in the future] ( https://github.com/metalbear-co/mirrord/issues/982 ) ).
96
96
97
+ > ** Note:** ` //go:build linux ` prevents certain Go test apps from being built on macOS. When using
98
+ > ` scripts/build_go_apps.sh ` , make the change below so the script continues building all other apps.
99
+ > ``` bash
100
+ > go build -o " $1 .go_test_app" || echo " Failed to build $directory /$1 .go_test_app"
101
+ > ` ` `
102
+
97
103
The basic command to run the E2E tests is:
98
104
` ` ` bash
99
105
cargo test --package tests
@@ -407,12 +413,20 @@ RUST_LOG=debug target/debug/mirrord exec -i test -l debug -c --target pod/py-ser
407
413
Server listening on port 80
408
414
```
409
415
410
- Send traffic to the Kubernetes Pod through the service
416
+ Send traffic to the Kubernetes Pod through the service. On Linux, run the following command:
411
417
412
418
```bash
413
419
curl $(minikube service py-serv --url)
414
420
```
415
421
422
+ On macOS, run the command below and keep the terminal open.
423
+
424
+ ```bash
425
+ minikube service py-serv --url
426
+ ```
427
+
428
+ Open another terminal and send traffic with `curl` to the service URL displayed by `minikube`.
429
+
416
430
Check the traffic was received by the local process
417
431
418
432
```bash
0 commit comments