Run CITE tests for ogcapi-features 1.0

* Add an `ogcapi-features` maven profile to `src/web/app/pom.xml` * Runs the CITE tests agains all the feature types in the "release" data directory * The WFS is configured to declare EPSG:4326 and EPSG:3857 for all FeatureTypes. Otherwise the tests will try to reproject amongst incompatible coordinate systems or boundaries. * `tiger:giant_polyon` is disabled. The test suite will try to reproject it even if it declares a single CRS.
groldan · Nov 7, 2024 · 24a8936 · 24a8936
1 parent ef583aa
commit 24a8936
Show file tree

Hide file tree

Showing 277 changed files with 7,940 additions and 148 deletions.
diff --git a/.github/workflows/cite.yml b/.github/workflows/cite.yml
@@ -0,0 +1,110 @@
+name: Run CITE Tests
+
+on:
+  push:
+#    branches:
+#      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-war:
+    runs-on: ubuntu-latest
+    name: Build GeoServer WAR
+    steps:
+      - name: Checkout repository (shallow clone)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+      - name: Set up Maven
+        uses: stCarolas/setup-maven@v5
+        with:
+          maven-version: 3.9.8
+      - name: Maven repository caching
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2/repository
+          key: gs-${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            gs-${{ runner.os }}-maven-
+
+      - name: Build geoserver.war
+        working-directory: build/cite
+        run: make war
+
+      - name: Upload geoserver.war as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: geoserver-war
+          path: build/cite/geoserver/geoserver.war
+
+  run-cite-tests:
+    needs: build-war
+    runs-on: ubuntu-latest
+    name: CITE
+    strategy:
+      fail-fast: false  # Prevents other matrix jobs from being canceled if one fails
+      matrix:
+        suite: [ogcapi-features10, wcs10, wcs11, wfs10, wfs11, wms10, wms11, wms13]
+        #suite: [ogcapi-features10, wms11, wcs11]
+
+    steps:
+      - name: Checkout repository (shallow clone)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Download geoserver.war artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: geoserver-war
+          path: build/cite/geoserver/
+
+      - name: List geoserver.war contents
+        run: unzip -l build/cite/geoserver/geoserver.war
+
+      - name: Build ogccite/geoserver:${{ matrix.suite }} docker image
+        working-directory: build/cite
+        run: make build suite=${{ matrix.suite }}
+
+      - name: Pull teamengine and other required images
+        working-directory: build/cite
+        run: make pull suite=${{ matrix.suite }}
+
+      - name: Run CITE tests for ogccite/geoserver:${{ matrix.suite }}
+        working-directory: build/cite
+        run: |
+          chmod o+w logs
+          make test suite=${{ matrix.suite }}
+
+      - name: Print GeoServer logs
+        if: always()
+        working-directory: build/cite
+        run: make print-logs suite=${{ matrix.suite }} service=geoserver
+
+      - name: Print TeamEngine logs
+        if: always()
+        working-directory: build/cite
+        run: make print-logs suite=${{ matrix.suite }} service=teamengine
+
+      - name: Shutdown containers
+        if: always()
+        working-directory: build/cite
+        run: make down
+
+      - name: Upload logs folder
+        uses: actions/upload-artifact@v3
+        with:
+          name: cite-${{ matrix.suite }}-logs
+          path: build/cite/logs/
diff --git a/build/cite/Makefile b/build/cite/Makefile
@@ -7,34 +7,123 @@
 .DEFAULT_GOAL := help
 .PHONY = help
 suite =
-war_url = "https://build.geoserver.org/geoserver/main/geoserver-main-latest-war.zip"
+# `make war` will build the war from ../src/web/app and copy it here
+war_url = ./geoserver/geoserver.war
+
+# alternatively you can use one in .war or .zip format from an URL, for example:
+# war_url = "https://build.geoserver.org/geoserver/main/geoserver-main-latest-war.zip"
+# but it may not have all the required extensions so make sure you know what you're doing
 
 
 help:
 	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
 
-clean:		## Will Clean the Environment of previous runs.
+clean:	down cleanlogs ## Will Clean the Environment of previous runs.
+
+down:
 	@echo Cleaning up previous runs
-	docker-compose down --remove-orphans --rmi all -v
-	docker-compose rm -vfs
+	docker compose down --remove-orphans -v
+	docker compose rm -vfs
+
+cleanlogs:
 	@echo Cleanning the previous logs.
 	rm -Rf logs/*
 
 build: $(suite)		## Will Build the GeoServer Docker Image for the Environment.
 	@echo Build the GeoServer Docker Image
-	docker-compose -f docker-compose.yml -f ./$(suite)/docker-compose.override.yml \
-      build --build-arg GEOSERVER_WEBAPP_SRC=${war_url} geoserver
+	docker compose -f compose.yml -f ./$(suite)/compose.override.yml \
+	build --no-cache --build-arg SOURCE_FILE=${war_url} geoserver
 
 version: $(suite)   ## Will give the version of the GeoServer on the current docker.
-		@echo Getting the GeoServer version.
-		docker run -i ogccite/geoserver:$(suite) bash -c 'cd /usr/local/tomcat/webapps/ && if [ -f geoserver.war ]; then unzip -q geoserver.war; cat META-INF/MANIFEST.MF; else cat META-INF/MANIFEST.MF; fi'
+	@echo Getting the GeoServer version.
+	docker run -i --rm ogccite/geoserver:$(suite) bash -c \
+	'cd /usr/local/tomcat/webapps/ && \
+	if [ -d geoserver ]; then cat geoserver/META-INF/MANIFEST.MF; \
+	elif [ -f geoserver.war ]; then jar -xf geoserver.war; cat META-INF/MANIFEST.MF; \
+	fi'
+
+test: $(suite)  ## Will run the Suite test with teamengine.
+ifeq ($(suite), ogcapi-features10)
+	$(MAKE) test-rest suite=$(suite)
+else
+	$(MAKE) test-cli suite=$(suite)
+endif
+
+test-cli: $(suite)
+	@echo running the Suite test with teamengine
+	docker compose -f compose.yml -f ./$(suite)/compose.override.yml \
+	  up --force-recreate --exit-code-from teamengine teamengine
+
+test-rest: $(suite)
+	@echo "running the Suite test with teamengine REST API"
+	$(MAKE) start suite=$(suite)
+	$(MAKE) run suite=$(suite)
+
+start: $(suite)  ## Launches the geoserver and teamengine containers
+	@echo starting containers
+	docker compose -f compose.yml -f ./$(suite)/compose.override.yml \
+		up -d --force-recreate
+
+run: $(suite)
+	$(MAKE) wait-for url="http://localhost:8090/geoserver/web/wicket/resource/org.geoserver.web.GeoServerBasePage/img/logo.png" timeout=60
+	$(MAKE) wait-for url="http://localhost:8080/teamengine/site/logo.png" timeout=60
+	docker compose -f compose.yml -f ./$(suite)/compose.override.yml \
+	exec teamengine /bin/bash -c "/run-test.sh $(suite)"
 
-test: $(suite) | version		## Will running the Suite test with teamengine.
-		@echo running the Suite test with teamengine
-		docker-compose -f docker-compose.yml -f ./$(suite)/docker-compose.override.yml \
-      up --force-recreate --exit-code-from teamengine teamengine
 
 webUI:		## Will running the Suite test with teamengine.
 	@echo running the Suite test with teamengine webUI
-	docker-compose -f docker-compose.yml -f ./interactive/docker-compose.override.yml \
-      up --force-recreate --no-deps --exit-code-from teamengine teamengine
+	docker compose -f compose.yml -f ./interactive/compose.override.yml \
+	up --force-recreate --no-deps --exit-code-from teamengine teamengine
+
+pull: $(suite)
+	@echo starting containers
+	docker compose -f compose.yml -f ./$(suite)/compose.override.yml \
+		pull --ignore-buildable
+
+war: build-war copy-war
+
+build-war:
+	mvn  -Pogcapi-features \
+	clean package -f ../../src/ -DskipTests -T1C -ntp
+
+copy-war:
+	cp ../../src/web/app/target/geoserver.war geoserver/geoserver.war
+
+# Usage: make wait-for url=<URL> timeout=<seconds>
+wait-for:
+	@if [ -z "$(url)" ]; then \
+		echo "Error: url parameter is required. Usage: make wait-for url=<URL> timeout=<seconds>"; \
+		exit 1; \
+	fi
+	@if [ -z "$(timeout)" ]; then \
+		echo "Error: timeout parameter is required. Usage: make wait-for url=<URL> timeout=<seconds>"; \
+		exit 1; \
+	fi
+	@echo "Waiting for $(url) to be available (timeout: $(timeout) seconds)..."
+	@start_time=$$(date +%s); \
+	while true; do \
+		elapsed_time=$$(( $$(date +%s) - $$start_time )); \
+		if [ $$elapsed_time -ge $(timeout) ]; then \
+			echo "Timeout reached: $(url) is not available after $(timeout) seconds"; \
+			exit 1; \
+		fi; \
+		if curl -s -o /dev/null -w "%{http_code}" $(url) | grep -E "^(200|302)$$" > /dev/null; then \
+			echo "$(url) is available!"; \
+			break; \
+		fi; \
+		echo "Waiting for $(url)..."; \
+		sleep 5; \
+	done
+
+.PHONY: print-logs
+print-logs:
+	@if [ -z "$(suite)" ]; then \
+		echo "Error: suite variable must be provided. Usage: make print-logs suite=<suite-name> [service=<service-name>]"; \
+		exit 1; \
+	fi
+	@if [ -n "$(service)" ]; then \
+		docker compose -f compose.yml -f ./$(suite)/compose.override.yml logs $(service); \
+	else \
+		docker compose -f compose.yml -f ./$(suite)/compose.override.yml logs; \
+	fi
diff --git a/build/cite/README.md b/build/cite/README.md
@@ -27,6 +27,7 @@ make clean build test suite=<suite test>
 
 ### example:
 Run the `wms11` suite:
+
 ```
 make clean build test suite=wms11
 ```
diff --git a/build/cite/compose.yml b/build/cite/compose.yml
@@ -0,0 +1,42 @@
+volumes:
+  gs_logs:
+  gs_gwc_cache_dir:
+
+services:
+  geoserver:
+    image: ogccite/geoserver:${GEOSERVER_TAG:-latest}
+    build:
+      context: .
+      dockerfile: ./geoserver/Dockerfile
+      args:
+        SOURCE_FILE: "https://build.geoserver.org/geoserver/main/geoserver-main-latest-war.zip"
+        # override as appropriate (e.g. ./wfs11/citewfs-1.1)
+        GEOSERVER_DATA_DIR_SRC:
+    ports:
+      - 8090:8080
+    env_file:
+      - ./.env
+      - ./geoserver/geoserver.env
+    environment:
+      JAVA_OPTS: >-
+        -Xms${HEAP_SIZE_MIN:-1024m}
+        -Xmx${HEAP_SIZE_MAX:-1024m}
+    volumes:
+    - gs_logs:/opt/geoserver_data/logs:rw
+    - gs_gwc_cache_dir:/opt/geowebcache_data:rw
+
+  teamengine:
+    # see https://github.com/opengeospatial/teamengine-docker
+    # there's ogccite/teamengine-production and ogccite/teamengine-beta
+    #image: ogccite/teamengine-production
+    image: geoserver-docker.osgeo.org/geoserver-cite:${TEAMENGINE_TAG:-teamengine_latest}
+    ports:
+      - 8080:8080
+    depends_on:
+      - geoserver
+    volumes:
+      # old teamengine location
+      - ./logs:/home/teamengine/te_base/users/teamengine:rw
+      # location used by new teamengine running tests through REST API
+      - ./logs:/usr/local/tomcat/te_base/users/ogctest/rest:rw
+      - ./run-test.sh:/run-test.sh
diff --git a/build/cite/docker-compose.yml b/build/cite/docker-compose.yml
diff --git a/build/cite/geoserver/.gitignore b/build/cite/geoserver/.gitignore
@@ -0,0 +1 @@
+geoserver.war
diff --git a/build/cite/geoserver/.placeholder b/build/cite/geoserver/.placeholder