grpc-ecosystem/grpc-gateway

Replace headless NodeJS browser tests

Open

#3235 opened on Mar 9, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
help wanted

Description

These tests were created back in 2015 and at some point they broke without actually signalling that they did. I want to get off this awful ecosystem of tools and onto something sane. Ideally something written in Go, but I'd take something written in TypeScript too.

The new tests must:

  • Use a client generated from our swagger.json
  • Exercise a reasonable amount of the gateway behaviour (at least equal to the current tests)
  • Use a minimal amount of NodeJS and the NPM ecosystem

Contributor guide

Tech stack
go
Domain
testingbackend
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programminggRPC basicsSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the existing test files in the repository, likely in a `gateway/` or `test/` directory. Locate the swagger.json file used for client generation. Understand the current headless browser tests and their setup. Identify the key gateway behaviors that need to be tested. Consider using Go's standard testing package and potentially a client generated from the swagger.json. Reference any open issues or PRs that discuss similar work.