payment: test fixtures hardcode real gateway names (govpay/lankapay) instead of generic placeholders

Open Beginner friendly
#122 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Quiet
Tech stack
go
Domain
testing

Research direction

Read payment/service_test.go, payment/handler_test.go, and payment/registry_test.go; use the existing generic IDs such as gw1 as the convention. Replace the govpay and lankapay fixture IDs consistently, then run the payment package tests. Done means the tests pass with generic placeholder IDs and no behavior changes.

Written by the indexing model from the issue text.

Description

Problem

core/payment's own unit tests hardcode a real downstream consumer's gateway name — \"govpay\" — as the fixture gatewayID throughout payment/service_test.go (~25 occurrences) and payment/handler_test.go (4 occurrences), and \"lankapay\" in a couple of places in payment/registry_test.go. Predates #118 (confirmed via git show against a commit before that PR's branch point), though #118 added a few more occurrences following the existing convention.

core/payment is a generic, gateway-agnostic SDK — its own README describes it as "designed to be imported and integrated into other repositories," with GovPay+/LankaPay named only as examples of gateways a consumer might wire up, not anything baked into the framework itself. Hardcoding a specific real downstream integration's name into the framework's own generic unit tests:

  • Couples tests that are actually exercising generic PaymentGateway/PaymentService/HTTPHandler mechanics to an integration that doesn't even live in this repo (GovPay+ lives in nsw-srilanka).
  • Reads as if there's GovPay+-specific behavior being tested here, when there isn't — the tests would behave identically with any gateway ID.
  • Is already inconsistent within the package: registry_test.go uses clearly-generic placeholder IDs (gw1, method1, method2) in most of its tests, but real names (lankapay) in a couple of others.

Proposed Solution

Standardize on the generic-placeholder convention registry_test.go already partially establishes (e.g. gw1) across service_test.go and handler_test.go, replacing the govpay/lankapay fixture IDs. Mechanical rename, no behavior change — tests pass identically regardless of the string used as the gateway ID.

Scope note

Deliberately not bundled into #118 (which is otherwise unrelated in scope) — flagged there during review and split out as its own follow-up per that PR's discussion.

Dominant language
Go
Stars
6
Forks
8
Avg merge
21h 36m
Merged PRs (30d)
42

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenNSW/core

All issues in OpenNSW/core

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.