Merge branch 'fix/weather-client-local-stub' into 'main'

test(examples): use local stub for HTTPClient/WeatherClient

See merge request arolang/aro!232

Author: KrisSimon

.gitlab-ci.yml

@@ -280,6 +280,15 @@ integration:linux:
     - timeout 60 ./aro-dist/aro build ./Examples/HelloWorld --verbose 2>&1 || echo "Build failed with exit code $?"
     - echo "=== aro build completed ==="
 
+    # Start local Open-Meteo stubs (offline HTTPClient / WeatherClient tests).
+    # Running them here, outside the test harness, avoids IPC::Run keeping
+    # pipes tied to backgrounded processes when a per-test pre-script exits.
+    - STUB_TIMEOUT=1800 nohup python3 Examples/HTTPClient/stub.py 18765 >/tmp/httpclient-stub.log 2>&1 </dev/null &
+    - STUB_TIMEOUT=1800 nohup python3 Examples/WeatherClient/stub.py 18766 >/tmp/weatherclient-stub.log 2>&1 </dev/null &
+    - for i in $(seq 1 50); do python3 -c 'import socket; s=socket.socket(); s.settimeout(0.2); exit(0 if s.connect_ex(("127.0.0.1",18765))==0 else 1)' && python3 -c 'import socket; s=socket.socket(); s.settimeout(0.2); exit(0 if s.connect_ex(("127.0.0.1",18766))==0 else 1)' && break; sleep 0.2; done
+    - python3 -c 'import urllib.request; print(urllib.request.urlopen("http://127.0.0.1:18765/v1/forecast").read()[:120])'
+    - python3 -c 'import urllib.request; print(urllib.request.urlopen("http://127.0.0.1:18766/v1/forecast").read()[:120])'
+
     - chmod +x test-examples.pl
     - perl test-examples.pl --verbose
   artifacts:

Examples/HTTPClient/main.aro

@@ -4,8 +4,12 @@
     Log "HTTP Client Demo" to the <console>.
     Log "Fetching weather data from Open-Meteo API..." to the <console>.
 
-    (* Create the API URL *)
-    Create the <api-url> with "https://api.open-meteo.com/v1/forecast?latitude=52.52&longitude=13.41&current_weather=true".
+    (* Create the API URL.
+       For reliable, offline-friendly tests this points at a local stub
+       (see stub.py). To call the real Open-Meteo API instead, replace
+       the URL below with:
+         "https://api.open-meteo.com/v1/forecast?latitude=52.52&longitude=13.41&current_weather=true" *)
+    Create the <api-url> with "http://127.0.0.1:18765/v1/forecast?latitude=52.52&longitude=13.41&current_weather=true".
 
     (* Simple GET request — response includes body, status, and headers *)
     Request the <response> from the <api-url>.

Examples/HTTPClient/stub.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+"""Local stub for the Open-Meteo weather API.
+
+Used by the HTTPClient example so that integration tests do not depend on
+api.open-meteo.com (which has occasional 502s and breaks unrelated CI runs).
+
+Behaviour:
+- Listens on 127.0.0.1:<port> (default 18765, override with $1).
+- Responds to any GET with a canned forecast JSON payload that mirrors the
+  fields the example expects (current_weather, current_weather_units, etc.).
+- Self-terminates after STUB_TIMEOUT seconds (default 1800) so a leaked
+  process cannot survive a CI job.
+"""
+import http.server
+import json
+import os
+import sys
+import threading
+
+PORT = int(sys.argv[1]) if len(sys.argv) > 1 else int(os.environ.get("STUB_PORT", "18765"))
+
+PAYLOAD = {
+    "latitude": 52.52,
+    "longitude": 13.41,
+    "elevation": 38.0,
+    "timezone": "GMT",
+    "timezone_abbreviation": "GMT",
+    "utc_offset_seconds": 0,
+    "current_weather": {
+        "interval": 900,
+        "is_day": 1,
+        "temperature": 12.3,
+        "time": "2026-04-07T08:00",
+        "weathercode": 3,
+        "winddirection": 210,
+        "windspeed": 9.4,
+    },
+    "current_weather_units": {
+        "interval": "seconds",
+        "temperature": "°C",
+        "time": "iso8601",
+        "weathercode": "wmo code",
+        "winddirection": "°",
+        "windspeed": "km/h",
+    },
+}
+
+
+class Handler(http.server.BaseHTTPRequestHandler):
+    def do_GET(self):
+        body = json.dumps(PAYLOAD).encode("utf-8")
+        self.send_response(200)
+        self.send_header("Content-Type", "application/json")
+        self.send_header("Content-Length", str(len(body)))
+        self.end_headers()
+        self.wfile.write(body)
+
+    def log_message(self, *_args, **_kwargs):
+        pass
+
+
+def main():
+    # Set SO_REUSEADDR so a quick restart doesn't hit TIME_WAIT.
+    http.server.HTTPServer.allow_reuse_address = True
+    server = http.server.HTTPServer(("127.0.0.1", PORT), Handler)
+    timeout = float(os.environ.get("STUB_TIMEOUT", "1800"))
+    threading.Timer(timeout, server.shutdown).start()
+    server.serve_forever()
+
+
+if __name__ == "__main__":
+    main()

Examples/HTTPClient/test.hint

@@ -2,3 +2,7 @@
 # Uses occurrence-check since API responses contain dynamic data (weather, timestamps)
 # Verifies HTTP client functionality and response structure
 occurrence-check: true
+# The Open-Meteo API is stubbed locally (see stub.py). In CI the stub is
+# started by the integration:linux before_script so it outlives each test.
+# For local runs we start/poll it from the pre-script.
+pre-script: if ! python3 -c 'import socket,sys; s=socket.socket(); s.settimeout(0.1); sys.exit(0 if s.connect_ex(("127.0.0.1",18765))==0 else 1)' 2>/dev/null; then (python3 Examples/HTTPClient/stub.py 18765 >/dev/null 2>&1 </dev/null &); for i in $(seq 1 100); do python3 -c 'import socket,sys; s=socket.socket(); s.settimeout(0.1); sys.exit(0 if s.connect_ex(("127.0.0.1",18765))==0 else 1)' 2>/dev/null && exit 0; sleep 0.1; done; echo "stub failed to start" >&2; exit 1; fi

Examples/WeatherClient/main.aro

@@ -1,7 +1,10 @@
 (* Fetch weather data from an external API *)
 (Application-Start: Weather Client) {
     Log "Fetching weather..." to the <console>.
-    Create the <api-url> with "https://api.open-meteo.com/v1/forecast?latitude=52.52&longitude=13.41&current_weather=true".
+    (* This points at a local stub (see stub.py) so the example does not
+       depend on a third-party service. To call the real Open-Meteo API,
+       use: "https://api.open-meteo.com/v1/forecast?latitude=52.52&longitude=13.41&current_weather=true" *)
+    Create the <api-url> with "http://127.0.0.1:18766/v1/forecast?latitude=52.52&longitude=13.41&current_weather=true".
     Request the <response> from the <api-url>.
     Extract the <weather> from the <response: body>.
     Log <weather> to the <console>.

Examples/WeatherClient/stub.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+"""Local stub for the Open-Meteo weather API.
+
+Used by the WeatherClient example so that integration tests do not depend on
+api.open-meteo.com (which has occasional 502s and breaks unrelated CI runs).
+
+Behaviour:
+- Listens on 127.0.0.1:<port> (default 18766, override with $1).
+- Responds to any GET with a canned forecast JSON payload that mirrors the
+  fields the example expects (current_weather, latitude, longitude, ...).
+- Self-terminates after STUB_TIMEOUT seconds (default 1800) so a leaked
+  process cannot survive a CI job.
+"""
+import http.server
+import json
+import os
+import sys
+import threading
+
+PORT = int(sys.argv[1]) if len(sys.argv) > 1 else int(os.environ.get("STUB_PORT", "18766"))
+
+PAYLOAD = {
+    "latitude": 52.52,
+    "longitude": 13.41,
+    "current_weather": {
+        "temperature": 12.3,
+        "windspeed": 9.4,
+        "winddirection": 210,
+        "weathercode": 3,
+    },
+}
+
+
+class Handler(http.server.BaseHTTPRequestHandler):
+    def do_GET(self):
+        body = json.dumps(PAYLOAD).encode("utf-8")
+        self.send_response(200)
+        self.send_header("Content-Type", "application/json")
+        self.send_header("Content-Length", str(len(body)))
+        self.end_headers()
+        self.wfile.write(body)
+
+    def log_message(self, *_args, **_kwargs):
+        pass
+
+
+def main():
+    # Set SO_REUSEADDR so a quick restart doesn't hit TIME_WAIT.
+    http.server.HTTPServer.allow_reuse_address = True
+    server = http.server.HTTPServer(("127.0.0.1", PORT), Handler)
+    timeout = float(os.environ.get("STUB_TIMEOUT", "1800"))
+    threading.Timer(timeout, server.shutdown).start()
+    server.serve_forever()
+
+
+if __name__ == "__main__":
+    main()

Examples/WeatherClient/test.hint

@@ -1,2 +1,6 @@
 mode: both
 occurrence-check: true
+# The Open-Meteo API is stubbed locally (see stub.py). In CI the stub is
+# started by the integration:linux before_script so it outlives each test.
+# For local runs we start/poll it from the pre-script.
+pre-script: if ! python3 -c 'import socket,sys; s=socket.socket(); s.settimeout(0.1); sys.exit(0 if s.connect_ex(("127.0.0.1",18766))==0 else 1)' 2>/dev/null; then (python3 Examples/WeatherClient/stub.py 18766 >/dev/null 2>&1 </dev/null &); for i in $(seq 1 100); do python3 -c 'import socket,sys; s=socket.socket(); s.settimeout(0.1); sys.exit(0 if s.connect_ex(("127.0.0.1",18766))==0 else 1)' 2>/dev/null && exit 0; sleep 0.1; done; echo "stub failed to start" >&2; exit 1; fi