lowRISC / lowRISC/opentitan

[bazel,python] refactor `bitstreams_workspace.py` to make it easier to test

Open
#15,820 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component:Software Component:Tooling Earlgrey-PROD Triaged Type:Cleanup Type:Enhancement
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

As [mentioned](https://github.com/lowRISC/opentitan/pull/15807#discussion_r1008361637) in #15807, the `bitstreams_workspace.py` script could use some refactoring to make it easier to test.

Additionally, the test script needs:
1. to be further enhanced to test all functionality, and
2. to be refactored to make use of test fixtures.

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 with bitstreams_workspace.py and the existing test script, then review the discussion linked from pull request #15807 for the refactoring context. Make the script easier to test, cover all of its functionality, and update the tests to use fixtures.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, testing
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.