PolicyEngine / PolicyEngine/policyengine-api

Expand live simulation integration coverage across US and UK

Open
#2,400 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
18
Forks
33
Avg merge
23h 40m
Merged PRs (30d)
22

Description

In #2384, we're looking to remove the Oregon rebate tests, which merely run the simulation over a particular policy. These tests are slow and can be clunky, so I think we should proceed with #2384, but they do serve as a basic integration/smoke test that ensures simulations run properly and they did successfully catch issues in #2398.

We should create one or more simulation integration tests. What I'd propose is more than 1, but fewer than 6, targeted at certain very important key policies. The list should include the following policies:

  1. The US Earned Income Tax Credit and/or Child Tax Credit
  2. The UK Universal Credit
  3. A bracketized policy (e.g., income tax)
  4. A state policy in a state with a high level of overall tax complexity (I'd nominate some program in California)

And should simultaneously deal with the following configurations:

  1. A standard US run
  2. A standard UK run
  3. A US state run
  4. A UK national run (i.e., England, Wales, Scotland, or Northern Ireland)

I do think we should remove the Oregon tests, but wait to merge #2388 until we can add at least one more relevant integration test.

Contributor guide

Open the contributing guide

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

Start by reading #2384, #2388, and #2398, then locate the existing Oregon simulation tests and their integration-test setup. Define one or more tests covering the listed US and UK policies and run configurations, while preserving basic simulation smoke coverage. Done means the new tests pass and provide coverage before the Oregon tests are removed through #2388.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.