Add example `tester` service to show API Integration Testing of a Goa System #331

jasondborneman · 2023-11-21T19:23:00Z

upgrade from goa v3.11.0 -> goa 3.14.0
- This caused a number of files to be updated mostly with change for the // Code generated by comment + changing interface{} to any
New tester service
New calls in front that wrap the tester service's TestAll and TestSmoke methods
New github action workflow that runs tester smoke tests via front service.

Initial

add readme file (still need to fill out)

tester readme update

raphael

This is awesome!! Left a bunch of nitpicks and comments

example/weather/services/front/clients/tester/client.go

example/weather/services/front/design/design.go

example/weather/services/tester/run_tests.go

example/weather/services/tester/testing.go

Implement review comment changes

codecov-commenter · 2023-11-28T00:31:19Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0097ea4) 94.30% compared to head (78ca536) 94.30%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #331   +/-   ##
=======================================
  Coverage   94.30%   94.30%           
=======================================
  Files          40       40           
  Lines        2249     2249           
=======================================
  Hits         2121     2121           
  Misses         95       95           
  Partials       33       33

Flag	Coverage Δ
micro	`94.30% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Trying out a workflow to run integration tests against local binaries

review fixes

…tPanic Get Stack Trace to Err Log on Panic

small fixes for style

raphael

Looks great, added a nit

raphael · 2023-12-02T21:32:43Z

.github/workflows/integration.yaml

+          ./bin/locator -monitoring-enabled=false &
+          ./bin/tester -monitoring-enabled=false &
+          ./bin/front -monitoring-enabled=false &
+          sleep 1


I wonder if we couldn't instead wait for the service health checks to start responding? Using sleep really isn't great... Maybe we could introduct a function such as:

check_service_health() { local health_url="$1" local start_time=$(date +%s) while : ; do if curl -s --fail "$health_url" > /dev/null; then echo "Service is up!" return 0 fi local current_time=$(date +%s) if (( current_time - start_time >= 5 )); then echo "Timed out waiting for service to be up." return 1 fi sleep 0.2 done }

and then call it for each service concurrently and wait for the calls to return:

check_service_health "http://localhost:????/healthz" & check_service_health "http://localhost:????/healthz" & check_service_health "http://localhost:????/healthz" & check_service_health "http://localhost:????/healthz" & wait

Had to tweak it a bit and add -n to the wait (otherwise it just hung) but this was a great suggestion, thanks!

raphael · 2023-12-02T21:35:03Z

example/weather/scripts/setup

@@ -9,10 +9,21 @@ source ./scripts/utils/common.sh

 proto_pkg="protobuf-compiler"

+# install protoc, update version as needed
+PROTO_VER=24.4


Latest version is 25.1 - it's a race! :)

protoc -> 25.1, better wait in integration.yaml

Jdb/tester/synchronoustests

raphael · 2024-01-06T01:31:27Z

Thank you for the awesome contribution!

… System (#331) * initial commit * Empty-Commit * add readme file (still need to fill out) * tester readme update * Trying out a workflow to run integration tests against local binaries * Add proto install to /example/weather/scripts/setup * fix integration.yaml * disable mono on ubuntu * move mono stop * Try to find out what's running on 8084 * Trying to disable mono? * trying to stop mono 2 * add a sleep after stop/disable? * add some echo * see if stop/disable mono fails * add back in || true, change front ports to see if this even works at all * oops forgot to change int test port * try no send to dev null? * sleep before testing * take out netstat * sleep longer? give time for docker to do work to get grafana? * remove dev>null again... :\ * sleep 60 :( * Implement review comment changes * Fix runTests check for filtering if * Empty-Commit * try starting each service individually, check fo rmono * just KILL mono? * back to 8084, check all ports * fix typo * add flag to turn off grafana for services (for CI testing) * clean up integration.yaml script * review fixes * Get Stack Trace to Err Log on Panic * small fixes for style * protoc -> 25.1, better wait in integration.yaml * Add synchronous testing feature * Make one of the synchronous as an example * move func maps to service definition

* Switch to using OpenTelemetry for both tracing and metrics This commit replaces the `metrics` and `trace` packages with a new `clue` package that leverages OpenTelemetry for instrumenting metrics and traces. See the README for instructions on how to upgrade. * Add tests * Remove coupling on Goa middleware * Use GRPC stat.handler for tracing in gRPC (#349) This replaces the deprecated use of interceptors. See open-telemetry/opentelemetry-go-contrib#3002. Remove use of Goa request ID middleware. This is superseded by logging span IDs. * Add example `tester` service to show API Integration Testing of a Goa System (#331) * initial commit * Empty-Commit * add readme file (still need to fill out) * tester readme update * Trying out a workflow to run integration tests against local binaries * Add proto install to /example/weather/scripts/setup * fix integration.yaml * disable mono on ubuntu * move mono stop * Try to find out what's running on 8084 * Trying to disable mono? * trying to stop mono 2 * add a sleep after stop/disable? * add some echo * see if stop/disable mono fails * add back in || true, change front ports to see if this even works at all * oops forgot to change int test port * try no send to dev null? * sleep before testing * take out netstat * sleep longer? give time for docker to do work to get grafana? * remove dev>null again... :\ * sleep 60 :( * Implement review comment changes * Fix runTests check for filtering if * Empty-Commit * try starting each service individually, check fo rmono * just KILL mono? * back to 8084, check all ports * fix typo * add flag to turn off grafana for services (for CI testing) * clean up integration.yaml script * review fixes * Get Stack Trace to Err Log on Panic * small fixes for style * protoc -> 25.1, better wait in integration.yaml * Add synchronous testing feature * Make one of the synchronous as an example * move func maps to service definition * Remove use of legacy flag --------- Co-authored-by: Jason Borneman <[email protected]>

jasondborneman and others added 3 commits November 21, 2023 14:19

initial commit

6f054d6

Empty-Commit

023ece6

Merge pull request #1 from jasondborneman/initial

836488c

Initial

jasondborneman marked this pull request as draft November 21, 2023 19:23

jasondborneman and others added 14 commits November 21, 2023 14:26

add readme file (still need to fill out)

5d9f33c

Merge pull request #2 from jasondborneman/initial

ced1c63

add readme file (still need to fill out)

tester readme update

c0d8ebb

Merge pull request #3 from jasondborneman/jdb/tester/readme

e7fe66e

tester readme update

Trying out a workflow to run integration tests against local binaries

4e59ab6

Add proto install to /example/weather/scripts/setup

9404ef6

fix integration.yaml

090cb8c

disable mono on ubuntu

4dd01db

move mono stop

e822a6d

Try to find out what's running on 8084

9883817

Trying to disable mono?

a23d09d

trying to stop mono 2

9868199

add a sleep after stop/disable?

f789909

add some echo

a87729c

raphael reviewed Nov 26, 2023

View reviewed changes

jasondborneman and others added 11 commits November 27, 2023 08:20

see if stop/disable mono fails

55a7c09

add back in || true, change front ports to see if this even works at all

d6cb3da

oops forgot to change int test port

5f90a03

try no send to dev null?

e819d44

sleep before testing

83a9691

take out netstat

54af7a6

sleep longer? give time for docker to do work to get grafana?

c99addc

remove dev>null again... :\

072f246

sleep 60 :(

5e51620

Implement review comment changes

ad0ff0c

Merge pull request #5 from jasondborneman/jdb/tester/fixes112723

0787db5

Implement review comment changes

jasondborneman added 5 commits November 27, 2023 15:39

Merge branch 'main' into jdb/tester/workflow

7c7495a

try starting each service individually, check fo rmono

c439738

just KILL mono?

c2dec1a

back to 8084, check all ports

104c195

fix typo

89be0d0

jasondborneman and others added 9 commits November 28, 2023 12:24

add flag to turn off grafana for services (for CI testing)

3817ebc

clean up integration.yaml script

09062f1

Merge pull request #4 from jasondborneman/jdb/tester/workflow

ad19923

Trying out a workflow to run integration tests against local binaries

review fixes

eb0f830

Merge pull request #7 from jasondborneman/jdb/tester/reviewfixes112823_1

2bcd647

review fixes

Get Stack Trace to Err Log on Panic

591c3cb

Merge pull request #8 from jasondborneman/jdb/tester/errlogStackOnTes…

fbddd73

…tPanic Get Stack Trace to Err Log on Panic

small fixes for style

1a94d26

Merge pull request #9 from jasondborneman/jdb/tester/smallfixes

715bd6e

small fixes for style

jasondborneman requested a review from raphael December 1, 2023 15:22

raphael reviewed Dec 2, 2023

View reviewed changes

jasondborneman and others added 2 commits December 4, 2023 08:30

protoc -> 25.1, better wait in integration.yaml

5245d74

Merge pull request #10 from jasondborneman/jdb/tester/workflow_fixes

eb6442f

protoc -> 25.1, better wait in integration.yaml

jasondborneman requested a review from raphael December 4, 2023 13:34

jasondborneman and others added 5 commits December 5, 2023 14:42

Add synchronous testing feature

ec3bc45

Make one of the synchronous as an example

ac71471

Merge pull request #11 from jasondborneman/jdb/tester/synchronoustests

adb3695

Jdb/tester/synchronoustests

Merge branch 'main' into merge-latest

d689bd6

move func maps to service definition

78ca536

jasondborneman marked this pull request as ready for review January 5, 2024 14:09

raphael merged commit 15fc752 into goadesign:main Jan 6, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add example `tester` service to show API Integration Testing of a Goa System #331

Add example `tester` service to show API Integration Testing of a Goa System #331

jasondborneman commented Nov 21, 2023 •

edited

Loading

raphael left a comment

codecov-commenter commented Nov 28, 2023 •

edited

Loading

raphael left a comment

raphael Dec 2, 2023

jasondborneman Dec 4, 2023

raphael Dec 2, 2023

raphael commented Jan 6, 2024

Add example tester service to show API Integration Testing of a Goa System #331

Add example tester service to show API Integration Testing of a Goa System #331

Conversation

jasondborneman commented Nov 21, 2023 • edited Loading

raphael left a comment

Choose a reason for hiding this comment

codecov-commenter commented Nov 28, 2023 • edited Loading

Codecov Report

raphael left a comment

Choose a reason for hiding this comment

raphael Dec 2, 2023

Choose a reason for hiding this comment

jasondborneman Dec 4, 2023

Choose a reason for hiding this comment

raphael Dec 2, 2023

Choose a reason for hiding this comment

raphael commented Jan 6, 2024

Add example `tester` service to show API Integration Testing of a Goa System #331

Add example `tester` service to show API Integration Testing of a Goa System #331

jasondborneman commented Nov 21, 2023 •

edited

Loading

codecov-commenter commented Nov 28, 2023 •

edited

Loading