Shopify / Shopify/toxiproxy

Re-organise folders structure

Open
#352 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Epic Toxiproxy
Dominant language
Go
Stars
12.4k
Forks
510
PR merge metrics
No merged PRs in 30d

Description

To follow best practices and allow us to have a better ability to test and develop new features, I would like to open discussion around packages reorganisation

toxiproxy/
├── bin/
├── cmd/
│   ├── cli/
│   │   └── main.go
│   ├── server/
│   │   └── main.go
│   └── dashboard
│       └── main.go
├── pkg/
│   ├── client/
│   │   └── ...
│   ├── server/
│   │   └── ...
│   ├── dashboard/
│   │   └── ...
│   └── toxics/
│   │   └── ...
│   └── stream/
│   │   └── ...
│   └── e2e/ (renamed `testing` see below)
│   │   └── ...
│   └── toxiproxytest/ (renamed `testhelper` see: https://pkg.go.dev/net/http/httptest)
│   │   └── ...
├── ...
└── README.md

Also I think it makes sense to restructure testing folder, since one of the files endpoint is used in Makefile to run e2e (maybe we just should rename it to be e2e/main.go) and benchmark_test.go is used only for benchmarking also in e2e tests.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Review the proposed cmd/ and pkg/ layout alongside the existing testing folder and Makefile. Start by tracing how endpoint, benchmark_test.go, and the e2e tests are invoked. Done means the package boundaries and naming are agreed and the reorganized tests and Makefile commands still work.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
build-system, developer-experience, testing
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.