finish crawler example, and add test to ci (#73)

* finish crawler example, and add test to ci

* separate run-examples job

.devcontainer/devcontainer.json

@@ -3,6 +3,7 @@
   "features": {
     "ghcr.io/devcontainers/features/git:1": "os-provided",
     "ghcr.io/devcontainers/features/rust:1": {},
+    "ghcr.io/devcontainers/features/go:1": {},
     "ghcr.io/devcontainers-contrib/features/protoc:1": {}
   }
 }

.github/workflows/ci.yaml

@@ -8,7 +8,7 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -21,10 +21,21 @@ jobs:
       run: cargo clippy -- -D warnings
     - name: Build
       run: make build
-    - name: cargo test --locked
+    - name: unit test
       run: cargo test --locked --all-targets
     # https://github.com/rust-lang/cargo/issues/6669
-    - name: cargo test --doc
+    - name: doc test
       run: cargo test --locked --all-features --doc
-    - name: Run e2e
+    - name: e2e test
       run: make e2e
+  run-examples:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-go@v5
+    - name: Install Protoc
+      uses: arduino/setup-protoc@v3
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+    - name: examples test
+      run: make test-examples

Cargo.toml

@@ -79,7 +79,7 @@ debug = []
 [[example]]
 name = "crawler"
 path = "examples/crawler.rs"
-required-features = ["full"]
+required-features = ["util"]
 
 [[test]]
 name = "lib"

Makefile

@@ -11,6 +11,9 @@ ifeq ($(ENABLE_TOKIO_CONSOLE), 1)
 	FEATURES += "debug"
 endif
 
+EXAMPLES = \
+	crawler
+
 .PHONY: build
 build:
 	RUSTFLAGS=$(RUSTFLAGS) cargo build $(if $(FEATURES),--features $(FEATURES))
@@ -57,6 +60,18 @@ check-version:
 build-examples:
 	DOCKER_BUILDKIT=1 docker build -t crawler:$(IMAGE_VERSION) -f go.Dockerfile .
 
+.PHONY: test-examples
+test-examples: build-examples build-docker
+	$(MAKE) -C examples stop
+	$(MAKE) -C examples start
+	$(MAKE) run-examples
+
+.PHONY: run-examples
+run-examples:
+	for example in $(EXAMPLES); do \
+		$(MAKE) -C examples run-example EXAMPLE=$$example; \
+	done
+
 .PHONY: clean
 clean:
 	rm -rf target

examples/Makefile

@@ -52,6 +52,11 @@ apply:
 stop: $(KIND)
 	$(KIND) delete cluster --name $(KIND_CLUSTER)
 
+EXAMPLE ?= crawler
+.PHONY: run-example
+run-example:
+	KUBECTL_BIN=$(KUBECTL) cargo run --package castled --example $(EXAMPLE) --features="full"
+
 $(KIND):
 	mkdir -p $(BIN_DIR)
 	curl -sSLf -o $@ https://github.com/kubernetes-sigs/kind/releases/download/$(KIND_VERSION)/kind-$(DL_OS)-$(DL_ARCH)
@@ -65,4 +70,4 @@ $(KUBECTL):
 $(ISTIOCTL):
 	mkdir -p $(BIN_DIR)
 	curl -sSLf https://github.com/istio/istio/releases/download/$(ISTIO_VERSION)/istioctl-$(ISTIO_VERSION)-$(DL_OSALT)-$(DL_ARCH).tar.gz \
-	| tar -C $(BIN_DIR) -xzf -
+	| tar -C $(BIN_DIR) -xzf -

src/lib.rs

@@ -8,5 +8,5 @@ pub mod client;
 pub mod debug;
 pub mod server;
 
-#[cfg(not(feature = "util"))]
+#[cfg(feature = "util")]
 pub mod util;