williaml33moore/bathtub

BDD Gherkin implementation in native SystemVerilog, based on UVM.

bathtub's Issues

Hide private files in docs from Jekyll

In the pages branch, the docs directory contains some files that should not be published to the web page.
Exclude them.

• Gemfile
• Gemfile.lock
• README.md

Override Monos `_includes` to add `baseurl` to paths

Copy all Monos theme _includes to my repo.
Add {{ site.baseurl }} as needed to fix broken URLs.
baseurl is set to bathtub since this is a project site, not a user site.

Implement running feature, scenario, step from string instead of file

The new parser structure enables this feature.
If I can parse strings instead of files, I can run powerful unit tests on the parser.

Convert long About page into Background

Test image upload

Create page for links and resources

Categories:

• BDD
• SystemVerilog / UVM

Resources

1. Pickles

2. BDD Addict

Add a social media preview

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview

Add links to Discussion at end of blog posts

Refactor Gherkin parser into its own class which implements the Visitor interface

Parser

Refactor Gherkin parser into its own class which implements the Visitor interface.Big change.

[] In progress

• Implement tasks:
• parse_feature_file(string filename)
• parse_feature_string(string feature)
• parse_feature_lines(ref string lines[])
• parse_feature_line_stream(mbox stream)
• parse_step_string(string step)
• parse_step_lines(ref string lines[])
• parse_step_line_stream(mbox stream)

Create Code of Conduct

Adding a code of conduct to your project
Wikimedia Foundation Universal Code of Conduct

Demote Fatal Errors

Don't have Bathtub throw fatal errors when steps don't exist. Instead throw normal errors, keep running. This is useful for interactive runs that might just require editing the feature file and rerunning.

Create discussion

Refer to Wikimedia Universal Code of Conduct

Change Monos Category references to Tag

Theme has a bug where the Category features should really be Tags. The screenshots in the original jekyll-theme-monos repo show that the navbar section used to be called "Tags."

The problem is that a post can only have one category, and an array of n categories is supposed to be treated as a hierarchy with depth n.

The fix is to rename everything "category," including file names, to "tag."

Create project

Gherkin Interfaces

Create interface classes for all Gherkin classes. Replace aggregates with uvm_pool objects. Supply accessors for their elements.Decided not to use uvm_pool. Native queues are fine.

[] To-do

Design an effective Home page

Ideas:

• Put a heading above blog posts
• A few useful bullets
• Focus on target viewers
• Direct to next steps, call to action
• "Getting started" link
• "Docs" link

Gherkin Immutablility

Make Gherkin objects immutable.Each has a new() constructor which constructs an empty element.But each also has a create_new() constructor with a complete set of arguments which are sufficient to create a new fully populated object with deep copies of all the arguments.

Accessors in the interfaces are getters only, no setters.

All members are protected.Gherkin parser uses new() to construct an empty element sufficient to call accept() on. All it's used for is visitor pattern double dispatch, then it's discarded. Parser collects element sub-elements recursively, then finally calls create_new().

Consider having getters for aggregates that return uvm_queue and dynamic arrays.e.g. function uvm_queue#(step) get_steps_as_queue() and function void get_steps_as_array(ref step[]);A wrinkle is that visit tasks don't return values. We can simulate returning values by supplying a uvm_queue for every function and use it as a stack. Each visitor function will push its return object onto its stack and the calling function can retrieve it. A bit Byzantine but it should work. We appear to be stretching the Visitor pattern to its limit. Got this to work with the return value stack but ultimately resolved this issue by changing parser so that it no longer implements Visitor pattern.

[] To-do

Visitor Functions

Gherkin visitor methods are currently tasks. Consider adding a parallel set of visitor functions.

• task visit()
• task accept()
• function void fn_visit() or visit_fn()
• function void fn_accept() or accept_fn()

Gherkin printer could probably use the functions.

[] Considering

Print a small sample step definition for missing steps

Hardest part will be coming up with a unique class name from the string. Maybe just replace spaces with underscores and prepend a backslash.

Reorganize directory structure

1. In bathtub repo main branch, commit logo from the pages branch so it's available in the main branch for the README.
2. In bathtub main branch, rename unit test directory to test.
3. In bathtub main branch, add scripts directory for future use.
4. Merge main branch changes into pages.

Create wiki page for bathtub_test_paper example

https://edaplayground.com/x/Prp5

1. Download and commit into new git examples directory.
2. Write a wiki page with an overview, file-by-file
3. Consider living documentation techniques like links from Wiki to code and even vice versa
4. Consider some automation to pull code examples into the Wiki repo