Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT] Add documentation generation #945

Closed
wants to merge 7 commits into from
Closed

Conversation

marioevz
Copy link
Member

Adds the --docs flag to the hive binary, which has the following effects:

  • Sets the HIVE_DOCS_MODE environment variable for the simulator container, which does the following:
    • The flag can be parsed by the hivesim library being used by (currently) all simulators and inhibit the execution of test functions that are not marked as AlwaysRun
    • The simulator will still send StartSuite, EndSuite, StartTest and EndTest requests to the hive server
  • Using the TestManager, the hive server collects the test suites and test cases and then proceeds to generate a markdown document for each suite containing every single test case into the simulator folder

The following fields are added to many structures, including the TestRequest, TestSuite and TestCase:

  • DisplayName: Allows specifying a different title for a test suite or test case to be displayed in the output markdown
  • Category: Allows grouping together many different test cases and add sections in the markdown file

In its current state, simulators still execute each test case in full because the hivesim dependency that inhibits execution in docs mode needs to be updated once this change makes it into the master branch.

@marioevz
Copy link
Member Author

Closed in favor of #948

@marioevz marioevz closed this Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant