Add files using upload-large-folder tool

testbed/cocotb__cocotb/.gitpod.Dockerfile

@@ -0,0 +1,56 @@
+FROM gitpod/workspace-full-vnc
+
+USER gitpod
+
+## Install Python with --enable-shared
+ARG PYTHON_VERSION=3.9.2
+RUN rm -rf ${HOME}/.pyenv/versions/${PYTHON_VERSION}
+RUN PYTHON_CONFIGURE_OPTS="--enable-shared" pyenv install ${PYTHON_VERSION}
+RUN pyenv global ${PYTHON_VERSION}
+
+RUN pip3 install --upgrade pip
+
+# Install extra packages
+RUN pip3 install -U pytest flake8 pylint pytype mypy gcovr cherrypy dowser
+
+# Re-synchronize the OS package index
+RUN sudo apt-get update
+
+# Install all needed packages for all simulators
+RUN sudo apt-get install -y perl make flex gnat gtkwave swig autoconf g++ bison libfl2 libfl-dev ccache libgoogle-perftools-dev numactl perl-doc
+RUN sudo rm -rf /var/lib/apt/lists/*
+
+## Install Icarus Verilog
+RUN brew install icarus-verilog
+
+## Install Verilator
+#ENV VERILATOR_BRANCH=stable
+ENV VERILATOR_BRANCH=v4.106
+
+RUN git clone https://github.com/verilator/verilator.git --branch ${VERILATOR_BRANCH} verilator \
+    && unset VERILATOR_ROOT \
+    && cd verilator \
+    && autoconf \
+    && ./configure \
+    && make --silent \
+    && sudo make --silent install \
+    && cd .. \
+    && rm -rf verilator
+
+## Install GHDL
+ENV GHDL_BRANCH=v1.0.0
+RUN git clone https://github.com/ghdl/ghdl.git --depth=1 --branch ${GHDL_BRANCH} ghdl \
+    && cd ghdl \
+    && ./configure \
+    && make --silent \
+    && sudo make --silent install \
+    && cd .. \
+    && rm -rf ghdl
+
+# Install cvc
+RUN git clone https://github.com/cambridgehackers/open-src-cvc.git --depth=1 cvc \
+    && cd cvc/src \
+    && make -f makefile.cvc64 --silent \
+    && sudo cp cvc64 /usr/local/bin \
+    && cd ../.. \
+    && rm -rf cvc

testbed/cocotb__cocotb/CONTRIBUTING.md

@@ -0,0 +1,537 @@
+# Cocotb Contribution Guidelines
+
+Welcome to the cocotb development!
+We are an inclusive community with the common goal of improving the cocotb, a coroutine based cosimulation library for writing VHDL and Verilog testbenches in Python.
+This guide explains how to contribute to cocotb, and documents the processes we agreed on to manage the project.
+All processes in this document are designed to streamline the development effort, to avoid bottlenecks, and to ultimately give a pleasant experience to all involved.
+
+
+## Getting Help
+
+Cocotb is a diverse and challenging project to contribute to.
+If you ever feel lost, out of your depth, or simply want to know more, the [cocotb Gitter channel](https://gitter.im/cocotb/Lobby) is actively watched by many cocotb users, contributors, and maintainers.
+It is a good idea if you are unsure whether your problem or question is worthy of a Github Issue to first post it to the Gitter channel.
+You may also ask questions in [Github issues](https://github.com/cocotb/cocotb/issues).
+If you don't receive any response on the Gitter channel or a Github issue, or you want help privately, you may directly contact a [maintainer](#maintainers).
+
+
+## What to Work On
+
+There is *a lot* of work to do on this project, no matter your area of expertise or skill level.
+
+If you are a beginner there are several [Github issues](https://github.com/cocotb/cocotb/issues) marked [`good first issue`](https://github.com/cocotb/cocotb/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) you can look at.
+There are also a number of things you can work on that aren't in Github issues and don't require in-depth knowledge of the cocotb internals.
+They including the following:
+
+* Documentation improvements
+* Managing Github issues and the Gitter channel
+* Testing and coverage improvements
+
+Cocotb is still not perfect. There are plenty of [bug fixes](https://github.com/cocotb/cocotb/issues?q=is%3Aopen+is%3Aissue+label%3Atype%3Abug) and [features](https://github.com/cocotb/cocotb/issues?q=is%3Aopen+is%3Aissue+label%3Atype%3Afeature) that can be worked on.
+Most of these are recorded as Github issues.
+
+
+### Documentation
+
+Cocotb's documentation is always open to improvements.
+Improving documentation will help users better understand and use cocotb;
+and may decrease the number of questions the Gitter channel and Github issue page.
+Updating documentation requires knowledge of:
+
+* [reStructuredText](https://docutils.sourceforge.io/rst.html)
+* [Sphinx documentation generator](https://www.sphinx-doc.org/en/master/)
+* [Markdown](https://www.markdownguide.org/)
+* [How to architect documentation](https://documentation.divio.com/)
+
+Some documentation should be located in the official documentation on [Read the Docs/RTD](https://docs.cocotb.org/en/latest/),
+while the rest belongs on the [Wiki](https://github.com/cocotb/cocotb/wiki).
+There are several ways to improve the documentation:
+
+* Better documenting core functionality (RTD)
+* Documenting common "gotchas" (RTD)
+* Documenting difficult and niche use cases (Wiki)
+* Documenting common design patterns (Wiki)
+* Documenting internal components (Wiki)
+
+See the documentation on [building the documentation](#building-documentation-locally) and the [guidelines on submitting pull requests](#patch-requirements).
+Documentation improvements typically require no maintainer pre-approval; you can simply work on the documentation and open a pull request.
+Documentation on the Wiki does not require a pull request; any user with a Github account can contribute to it.
+Please be responsible with that power.
+
+
+### Project Management
+
+The cocotb project is [fairly popular](https://larsasplund.github.io/github-facts/verification-practices.html#frameworks) and the
+[Gitter channel](https://gitter.im/cocotb/Lobby) and
+[Github issues](https://github.com/cocotb/cocotb) page receive a fair amount of traffic;
+which is only expected to increase.
+People are needed to categorize issues and pull requests, and respond to questions.
+Working this task is the quickest way to learn how cocotb works.
+Tending to this task requires the following:
+
+* people skills
+* an understanding of the scope of cocotb
+* general understanding about how cocotb works
+
+Someone working this task should set notifications on the Gitter channel to be notified of any new comments.
+They should also "watch" the Github repo by selecting the "Watching" notification level button in the upper right corner of the main Github page.
+Finally, they should notify the maintainers that they are able and willing to accept questions.
+
+To be able to add labels and close issues and PRs you will need special permissions.
+Contact a [maintainer](#maintainer) if you are interested in receiving these permissions.
+They will be granted according to the project's need and the requestor's familiarity with cocotb.
+Once you have those permissions, see the guidelines on [managing issues and pull requests](#Managing-of-Issues-and-Pull-Requests).
+
+This task can also be done without special repo permissions, by just commenting on the issue or PR.
+This is especially helpful for Github issues about bugs.
+If you can duplicate the bug or confirm the bug report is invalid, that helps maintainers *a lot*.
+
+
+### Tests and Coverage
+
+Cocotb has a suite of unit tests (located in the `tests` directory) and examples (located in the `examples` directory) which are functional acceptance tests.
+If a pull request cannot pass *all* of these tests, it will likely be rejected.
+To ensure cocotb only includes the highest quality code, these test should be exhaustive.
+We use code coverage as a quantifiable metric of the "exhaustiveness" of these tests, and wish to improve this metric.
+
+Working on this task requires a familiarity with:
+
+* Cocotb's core functionality
+* How to write Verilog and VHDL
+* How to write cocotb tests in Python
+* (Optionally) [codecov](https://docs.codecov.io/docs); coverage aggregator and Github bot
+* (Optionally) the [coverage](https://coverage.readthedocs.io/en/latest/) module, for Python code coverage
+* (Optionally) [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html), for C++ code coverage
+* (Optionally) [Github Actions](https://docs.github.com/en/free-pro-team@latest/actions), for automatic acceptance testing
+
+Cocotb's regression tests can be improved by:
+
+* Testing more of cocotb's core functionality
+* Testing corner cases left out of the current set of tests (identified by looking at code coverage)
+* Increasing the matrix of simulators, operating system, and Python installations tested in CI
+
+Testing improvements don't require maintainer pre-approval, but require a pull request.
+Please see the [guidelines on submitting pull requests](#patch-requirements).
+
+
+### Features
+
+Cocotb is still in development and new features are still welcome and appreciated;
+as long as they stay [in scope](#Architecture-and-Scope-of-Cocotb).
+Cocotb is comprised of several major codebases, each requiring different sets of skills and development process.
+Instead of including that breakdown here, it is done in the [internal documentation](https://github.com/cocotb/cocotb/wiki/cocotb-Internals).
+
+Small improvements to existing features generally do not require maintainer pre-approval.
+Large changes, approximately >150 LOC changed, and new features generally require maintainer pre-approval.
+If a change is deemed too large for the main repo, or out of scope,
+please feel free to make it an [extension](https://docs.cocotb.org/en/latest/extensions.html).
+
+***New features must not break existing features.***
+
+Feature changes require full coverage of the added feature.
+This likely requires adding new unit tests to the `tests` directory.
+Issue-specific test directories will not be accepted, unless a special HDL entity is required.
+Instead, place the test in an existing test suite (`test_cocotb`, `test_discovery`, etc.).
+
+Features should generally follow the following design principles:
+
+* Something the user cannot do without assistance of cocotb-specific code
+* Orthogonal to existing features
+* Easily composed with existing features
+* Limited in scope and impervious to scope creep
+
+
+### Bugfixes
+
+**!WARNING!** Bugfixing cocotb is not for the faint of heart!
+
+Bugs happen.
+cocotb supports many simulators that have inconsistent support for the procedural interfaces cocotb depends on,
+and it has a number of features that aren't wholly tested yet.
+There are likely many bugs lurking, waiting to be found;
+which is why increasing testing and code coverage is important.
+Working on bugfixing can be very challenging, depending on the cause of the bug.
+In general, bugfixing requires knowledge of:
+
+* How cocotb works
+* [cocotb's debugging utilities](https://github.com/cocotb/cocotb/wiki/Debugging-HOW-TOs#cocotb-debugging-functionality)
+* (Optional) Simulator interfaces (VPI, VHPI, and FLI)
+* (Optional) Python debugging tools ([pdb](https://github.com/cocotb/cocotb/wiki/Debugging-HOW-TOs#using-a-remote-python-debugger), [dowser](https://github.com/cocotb/cocotb/wiki/Debugging-HOW-TOs#debugging-python-memory-usage))
+* (Optional) C/C++ debugging tools ([gdb](https://github.com/cocotb/cocotb/wiki/Debugging-HOW-TOs#using-a-remote-cc-debugger), [valgrind](https://github.com/cocotb/cocotb/wiki/Debugging-HOW-TOs#debugging-cc-memory-usage))
+* (Optional) Specific simulators (sometimes the bug exists in the simulator and not cocotb)
+
+Fixing a bug follows the procedure:
+
+1. Locate buggy behavior, make a Github issue
+    * Maintainers may be able to offer more information, confirm it as a bug, or confirm it as expected behavior
+2. Make a Minimum Reproducible Failing Example (MRFE, pronounced like Murphy, like the law :)
+    * Confirms the bug
+    * Add to [regressions](#running-tests-locally)
+3. Open a new draft pull request with the MRFE test
+    * It should cause CI to fail
+4. Determine scope of the bug, and add that detail to the pull request
+    * Which simulators/interfaces are affected?
+    * Which Python versions?
+    * Which operating systems?
+5. Determine the cause of the bug, and add that detail to the pull request
+    * May require Python or C debugging, or the builtin cocotb debugging utilities
+6. Make a fix, and push it up on the PR branch
+    * It should cause the CI to pass
+    * The fix should not break other existing functionality
+
+Details on how to debug cocotb can be found on the [Wiki](https://github.com/cocotb/cocotb/wiki/Debugging-HOW-TOs).
+
+
+### Deprecations and Removals
+
+Cocotb's treatment of deprecations and removal follows guidelines laid out [here](https://symfony.com/doc/current/setup/upgrade_major.html#make-your-code-deprecation-free).
+Deprecations serve the following purposes:
+
+* Remove legacy code that has been deemed out of scope
+* Remove support for a simulator, OS, or Python version that is past end-of-life
+* Remove potentially dangerous, broken, and misunderstood interfaces (usually accompanied with a superior alternative)
+
+Deprecations can be incorporated at any time.
+They are implemented in Python by [issuing a `DeprecationWarning`](https://docs.python.org/3/library/warnings.html#warnings.warn)
+or using the [`@deprecated`](cocotb/_deprecation.py) decorator.
+In C++ code, deprecations are implemented by [issuing a LOG_WARN](https://docs.cocotb.org/en/stable/generated/file/gpi__logging_8h.html?highlight=LOG_WARN#c.LOG_WARN) with `DEPRECATED` in the message.
+
+Removals only occur on major version bumps.
+One can create removal pull requests at any time, on the condition they will not be accepted until the next release is known to be a major version release.
+
+
+### Breaking Changes
+
+Breaking changes are changes to the interface or behavior of a user-facing entity.
+They are necessary when a user-facing interfaces are broken in a way that cannot be changed without changing the behavior of user's code.
+In these situations it is ideal to be able to implement a switch between new better behavior and the old broken behavior.
+On major version bumps, this switch will be deprecated and the new behavior will become the default.
+
+In cases where behavioral switches are not easy to implement, breaking changes will attempt to be broadcasted to user by [issuing a `DeprecationWarning`](https://docs.python.org/3/library/warnings.html#warnings.warn) when the to-be-changed behavior is invoked.
+Before major releases, pending breaking changes will be incorporated.
+
+One can create pull requests with breaking changes at any time, on the condition they will not be accepted until the next release is known to be a major version release.
+
+
+## Setting Up a Development Environment
+
+Assuming you have used cocotb prior to reading this guide, you will already have the cocotb [installation prerequisites](https://docs.cocotb.org/en/latest/install.html) and standard development tools (editor, shell, git, etc.) installed.
+
+First, you should [fork and clone](https://guides.github.com/activities/forking/) the cocotb repo to your machine.
+This will allow you to make changes to the cocotb source code, create pull requests, and run regressions and build documentation locally.
+
+Additionally, you will need [doxygen](https://www.doxygen.nl/index.html), for building documentation;
+[nox](https://pypi.org/project/nox/), for building documentation and running regression tests;
+and [pre-commit](https://pre-commit.com/), to check your changes before committing them.
+
+We recommend if you are using a Linux distribution to use your system package manager to install doxygen.
+Likewise, doxygen can be installed using the homebrew package manager on Mac OS.
+Windows contributors should download a binary distribution installer from the main website.
+
+`nox` and `pre-commit` are Python projects and can be installed with `pip`:
+
+```command
+pip install nox pre-commit
+```
+
+To enable pre-commit run the following command at the root of the cloned project to install the git hooks.
+The first run of pre-commit will build an environment for you, so it may take a while.
+Following runs should be much quicker.
+
+```command
+pre-commit install
+```
+
+When committing, pre-commit's hook will run, checking your changes for formatting, code smells, etc.
+You will see the lists of checks printed and whether they passed, were skipped, or failed.
+If any of the checks fail, it is recommended to fix them before opening a pull request,
+otherwise the pull request checks will fail as well.
+
+Now you are ready to contribute!
+
+
+## Running Tests Locally
+
+First, [set up your development environment](#setting-up-a-development-environment).
+
+Our tests are managed by `nox`, which runs both `pytest` tests and our system of makefiles.
+The regression does not end on the first failure, but continues until all tests in the `/tests` and `/examples` directories have been run.
+
+To run the tests locally with `nox`, issue the following command.
+
+```command
+nox -s dev_test
+```
+
+At the end of the regression, if there were any test failures, the tests that failed will be printed.
+If the tests succeed you will see the message `Session tests was successful` printed in green.
+
+By default the `dev_test` nox session runs all simulator-agnostic tests, as well as all tests which require a simulator and can be run against Icarus Verilog.
+Icarus Verilog must be installed.
+
+The simulator and the toplevel language can be changed by setting the environment variables [`SIM`](https://docs.cocotb.org/en/latest/building.html#var-SIM) and [`TOPLEVEL_LANG`](https://docs.cocotb.org/en/latest/building.html#var-TOPLEVEL_LANG).
+Alternatively, the simulator-specific nox sessions can be used, as described below.
+
+### Selecting a Language and Simulator for Regression
+
+cocotb can be used with multiple simulators, and can run tests against all of them.
+Nox provides a session for each valid simulator/language/GPI interface combination, from which one or multiple sessions can be selected.
+
+The following examples are good starting points;
+refer to the [nox command-line usage documentation](https://nox.thea.codes/en/stable/usage.html) for more information.
+
+```command
+# List all available sessions.
+nox -l
+
+# Run all simulator-agnostic tests.
+nox -s dev_test_nosim
+
+# Run the simulator-specific tests against Xcelium, using a VHDL toplevel and
+# the VHPI interface.
+nox -s "dev_test_sim(sim='xcelium', toplevel_lang='vhdl', gpi_interface='vhpi')"
+
+# Run all simulator-specific tests against Icarus Verilog and GHDL.
+# Both simulators must be installed locally.
+nox -k "dev_test_sim and (icarus or ghdl)"
+```
+
+### Running Individual Tests Locally
+
+Each test under `/tests/test_cases/*/` and `/examples/*/tests/` can be run individually.
+This is particularly useful if you want to run a particular test that fails the regression.
+
+First you must install cocotb from source by navigating to the project root directory and issuing the following command:
+
+```command
+python -m pip install .
+```
+
+On Windows, you must instead install cocotb from source like so:
+
+```command
+python -m pip install --global-option build_ext --global-option --compiler=mingw32 .
+```
+
+Once that has been done, you can navigate to the directory containing the test you wish to run.
+Then you may issue an [appropriate](https://docs.cocotb.org/en/latest/building.html#makefile-based-test-scripts) `make` command.
+For example, if you want to test with Icarus using Verilog sources:
+
+```command
+make SIM=icarus TOPLEVEL_LANG=verilog
+```
+
+
+## Building Documentation Locally
+
+First, [set up your development environment](#setting-up-a-development-environment).
+
+Documentation is built locally using `nox`.
+The last message in the output will contain a URL to the documentation you just built.
+Simply copy and paste the link into your browser to view it.
+The documentation will be built in the same location on your hard drive on every run, so you only have to refresh the page to see new changes.
+
+To build the documentation locally on Linux or Mac, issue the following command:
+
+```command
+nox -e docs
+```
+
+Building the documentation is not currently supported on Windows.
+
+
+## Architecture and Scope of Cocotb
+
+Cocotb has seen adoption in a wide variety of scenarios with sometimes conflicting requirements.
+To foster experimentation and to decentralize the development process the architecture of cocotb is highly modular.
+A solid core forms the foundation upon which extensions can provide higher-level functionality.
+
+The core of cocotb are
+- the infrastructure to write testbenches with coroutines, threads, etc.,
+- the abstraction and interaction with simulators through interfaces like VPI, GPI, etc.,
+- tooling to run tests, and
+- core primitives to interact with the simulation: triggers, data access classes, etc.
+
+As a general rule, functionality beyond this core set should go into extensions.
+However, none of these rules are set in stone.
+They can and should be challenged at times to ensure the project stays relevant to the majority of its users.
+
+
+## Maintainer Pre-approval
+
+After making changes to cocotb, changes must be approved by at least one maintainer before being included.
+Out-of-scope and breaking changes ***will not be accepted***.
+Also a maintainer could object to a change due to implementation approach or code quality reasons.
+To potentially save you frustration and time, it is a good idea to get maintainer pre-approval on the task before starting it.
+
+The best way to get maintainer pre-approval is to make a [Github issue](https://github.com/cocotb/cocotb/issues).
+These issues can be a place for maintainers, as well as other users, to voice opinions on a proposed change before the task is worked.
+You may also propose changes on the [Gitter channel](https://gitter.im/cocotb/Lobby) or by directly contacting a [maintainer](#maintainer).
+
+
+## How to Get Changes Merged
+
+Have you fixed a bug in cocotb, or want to add new functionality to it?
+Cocotb follows the typical [GitHub flow](https://guides.github.com/introduction/flow/) and makes use of pull requests and reviews.
+Follow the steps below to get your changes merged, i.e. integrated into the main cocotb codebase.
+
+1. Create an issue ticket on [cocotb's GitHub issue tracker](https://github.com/cocotb/cocotb/issues) describing the problem.
+   Issues are also a good place to discuss design options with others before writing code.
+2. [Fork](https://help.github.com/articles/fork-a-repo/) the [cocotb GitHub repository](https://github.com/cocotb/cocotb) into your personal namespace.
+3. Create a new branch off the `master` branch for your set of changes.
+   Use one branch per "topic," i.e. per set of changes which belong together.
+4. Create one or multiple commits to address the issue.
+   Make sure to read and follow the [Patch Requirements](#patch-requirements) when preparing your commits.
+5. Create new [pull request (PR)](https://github.com/cocotb/cocotb/pulls).
+6. When you submit (or update) the pull request, a suite of regression tests will run.
+   If any of them turns "red," i.e. reports a failure, you most likely need to fix your code before it can be merged.
+7. The pull request needs to be reviewed by at least one maintainer.
+   We aim to give feedback to all pull requests within a week, but as so often, life can get in the way.
+   If you receive no feedback from a maintainer within that time, please contact them directly (e.g. on [Gitter](https://gitter.im/cocotb) or email).
+   You can find a [list of all maintainers](#maintainers) below.
+   If a maintainer asks you to explain or modify code, try to do so.
+8. Once your code has at least one positive review from a maintainer and no maintainer strongly objects it your code is ready to be merged into the `master` branch.
+
+
+## Patch Requirements
+
+All changes which should go into the main codebase of cocotb must follow this set of requirements.
+
+- The code must be within the [scope of cocotb](#architecture-and-scope-of-cocotb).
+- All code must be licensed under the [Revised BSD License](https://github.com/cocotb/cocotb/blob/master/LICENSE).
+  By contributing to this project you signal your agreement with these license terms.
+- All code must follow the established coding standards:
+   - For Python code, follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide.
+   - For C++ code, follow the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) but with 4 space indentation.
+     You can run the following command to automatically format the modified file to match the standard:
+     ```command
+     clang-format -i <file>
+     ```
+- All code must pass existing tests.
+  New functionality must be accompanied by tests, and bug fixes should add tests to increase the test coverage and prevent regressions.
+- If code changes or enhances documented behavior the documentation should be updated.
+- If a change is user-visible, a newsfragment should be added to `docs/source/newsfragments`.
+- All pull requests must be accepted by at least one maintainer, with no maintainer strongly objecting.
+  Reviews must be performed by a person other than the primary author of the code.
+- All commits should follow established best practices when creating a commit message:
+   - The first line of the commit message is the short summary of what the code change does.
+     Keep this line below 50 characters.
+   - Then have one blank line.
+   - Now comes the long description of the commit.
+     Use this text to discuss things which are not obvious from the code, especially *why* changes were made.
+     Include the GitHub issue number (if one exists) in the form "Fixes #nnn" ([read more about that](https://help.github.com/articles/closing-issues-using-keywords/)).
+     Keep each description line below 72 characters.
+- Use the following header for new non-example files:
+  ```python
+  # Copyright cocotb contributors
+  # Licensed under the Revised BSD License, see LICENSE for details.
+  # SPDX-License-Identifier: BSD-3-Clause
+  ```
+- Use the following header for new example files:
+  ```python
+  # This file is public domain, it can be freely copied without restrictions.
+  # SPDX-License-Identifier: CC0-1.0
+  ```
+
+## Managing of Issues and Pull Requests
+
+The cocotb project makes use of GitHub labels attached to issues and pull requests to structure the development process.
+Each issue and pull request can have multiple labels assigned.
+
+The `type` labels define the type of issue or PR:
+- `type:bug`: a bug in existing functionality
+- `type:feature`: new functionality
+- `type:question`: a support question
+- `type:cleanup`: cleanup or refactoring on code, documentation, or other areas
+- `type:deprecation`: API that should warn and eventually be removed
+
+The `status` labels give a quick impression of the current status of the issue or PR:
+- `status:worksforme`: the issue it not reproducible, or intended behavior (i.e. not a bug)
+- `status:blocked`: further progress is blocked by a dependency, e.g. other code which must be commited first.
+- `status:needs-info`: feedback from someone is required. The issue/PR text gives more details.
+- `status:duplicate`: the same issue is already being handled in another issue/PR.
+- `status:close?`: issues which can probably be closed, but need a second pair of eyes
+- `status:needs-proprietary-testing`: Help needed testing on a proprietary tool
+- `status:out-of-scope`: An issue or PR that was closed because the feature or bug was deemed to be out of scope
+
+For the use in pull requests the following additional status labels are defined:
+- `status:needs-review`: this PR needs at least one review
+- `status:changes-requested`: changes are requested to the code
+- `status:ready-for-merge`: this PR is ready (according to the [Patch Requirements](#patch-requirements)) to be merged
+- `status:needs-rebase`: needs a git rebase
+- `status:needs-newsfragment`: Needs a towncrier newsfragment for the changelog
+
+The `category` labels help maintainers to filter issues which are relevant to their area of expertise:
+- `category:OS:MacOS`: Mac OS/OS X specific issues
+- `category:OS:Linux`: Linux specific issues
+- `category:OS:Windows`: Microsoft Windows-specific issues
+- `category:simulators`: simulator support, including VPI/GPI/etc.
+- `category:simulators:activehdl`: Aldec Active-HDL
+- `category:simulators:cvc`: Tachyon CVC
+- `category:simulators:ghdl`: GHDL
+- `category:simulators:icarus`: Icarus Verilog (iverilog)
+- `category:simulators:ius`: Cadence Incisive (IUS)
+- `category:simulators:modelsim`: Mentor Modelsim
+- `category:simulators:questa`: Mentor Questa
+- `category:simulators:riviera`: Aldec Riviera-PRO
+- `category:simulators:vcs`: Synopsys VCS
+- `category:simulators:verilator`: Verilator
+- `category:simulators:xcelium`: Cadence Xcelium
+- `category:codebase:gpi`: relating to the GPI or one of the implementation
+- `category:codebase:pygpi`: relating to the Python wrapper around the GPI (embed library and simulator module)
+- `category:codebase:scheduler`: relating to the coroutine scheduler, triggers, or coroutine objects
+- `category:codebase:test-runner`: relating to code for automating test runs (regression manager)
+- `category:codebase:handle`: relating to handles or handle types (BinaryValue)
+- `category:codebase:project-automation`: relating to included project automation (makefiles)
+- `category:codebase:testbenching`: relating to testbenching components (Drivers, Monitors, etc.)
+- `category:building`: relating to build C/C++ libraries and extension modules
+- `category:packaging`: issues related to (PyPi) packaging, etc.
+- `category:docs`: documentation issues and fixes
+- `category:extensions`: cocotb extensions
+- `category:performance`: performance topics
+- `category:tests-ci`: continuous integration and unit tests
+
+To help new contributors find a good issue to work on one more label is used (following [GitHub standard practices](#https://help.github.com/articles/helping-new-contributors-find-your-project-with-labels/)):
+- `good first issue`: this issue is a good starting point for new contributors.
+  The issue should give an actionable description of what to do to complete this task, along with contact information of a mentor for this task.
+
+cocotb explicitly uses no priority labels, as experience indicates that they provide little value.
+
+Issues and pull requests which are invalid, or where feedback is lacking for four weeks, should be closed.
+
+## Cocotb Releases
+
+cocotb aims to keep the `master` branch always in a releasable state.
+At least four times a year an official release should be created.
+It is the job of the maintainers to find a suitable time for a release, to communicate it to the community, and to coordinate it.
+
+## Maintainers
+
+Cocotb uses a shared maintainer model.
+Most maintainers are experts in part of the cocotb codebase, and are primarily responsible for reviews in this area.
+
+- Kaleb Barrett (@ktbarrett)
+- Tomasz Hemperek (@themperek)
+- Marlon James (@marlonjames)
+- Colin Marquardt (@cmarqu)
+- Philipp Wagner (@imphil)
+- Eric Wieser (@eric-wieser)
+
+Founders
+
+- Chris Higgs (@chiggs)
+- Stuart Hodgson (@stuarthodgson)
+
+### Getting in Contact with a Maintainer
+
+All of the maintainers are active on the [Gitter channel](https://github.com/cocotb/cocotb).
+They prefer inquiries go through direct messages on Gitter,
+or by mentioning them in the main [cocotb Gitter channel](https://gitter.im/cocotb/Lobby) using `@{maintainer name}`.
+Maintainers are unpaid volunteers, so it might take a while for a maintainer to get back to you.
+
+
+## Code of Conduct
+
+The cocotb development community aims to be welcoming to everyone.
+The [FOSSi Foundation Code of Conduct](https://www.fossi-foundation.org/code-of-conduct) applies.
+Please contact any of the maintainers if you feel uncomfortable in the cocotb development community.

testbed/cocotb__cocotb/tests/benchmark.py

@@ -0,0 +1,62 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+import sys
+from pathlib import Path
+
+from cocotb.runner import get_runner
+
+
+def build_and_run_matrix_multiplier(benchmark, sim):
+    hdl_toplevel_lang = "verilog"
+    build_args = []
+    test_args = []
+
+    if sim == "nvc":
+        build_args = ["--std=08"]
+        hdl_toplevel_lang = "vhdl"
+
+    verilog_sources = []
+    vhdl_sources = []
+
+    proj_path = (
+        Path(__file__).resolve().parent.parent / "examples" / "matrix_multiplier"
+    )
+
+    sys.path.append(str(proj_path / "tests"))
+
+    if hdl_toplevel_lang == "verilog":
+        verilog_sources = [proj_path / "hdl" / "matrix_multiplier.sv"]
+    else:
+        vhdl_sources = [
+            proj_path / "hdl" / "matrix_multiplier_pkg.vhd",
+            proj_path / "hdl" / "matrix_multiplier.vhd",
+        ]
+
+    runner = get_runner(sim)
+
+    runner.build(
+        hdl_toplevel="matrix_multiplier",
+        verilog_sources=verilog_sources,
+        vhdl_sources=vhdl_sources,
+        build_args=build_args,
+    )
+
+    @benchmark
+    def run_test():
+        runner.test(
+            hdl_toplevel="matrix_multiplier",
+            hdl_toplevel_lang=hdl_toplevel_lang,
+            test_module="test_matrix_multiplier",
+            test_args=test_args,
+            seed=123456789,
+        )
+
+
+def test_matrix_multiplier_icarus(benchmark):
+    build_and_run_matrix_multiplier(benchmark, "icarus")
+
+
+def test_matrix_multiplier_nvc(benchmark):
+    build_and_run_matrix_multiplier(benchmark, "nvc")

testbed/cocotb__cocotb/tests/sxs.ps1

@@ -0,0 +1,15 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# Run this script with:
+# powershell -executionpolicy bypass -File tests\sxs.ps1
+
+$j = Start-Job -ScriptBlock { SxsTrace Trace -logfile:SxsTrace.etl }
+Start-Sleep -s 5
+python -c "import cocotb.simulator"
+Start-Sleep -s 5
+$j | Stop-Job
+SxsTrace Stoptrace
+SxsTrace Parse -logfile:SxsTrace.etl -outfile:SxsTrace.txt
+Get-Content SxsTrace.txt

testbed/cocotb__cocotb/tests/test_cases/issue_253/issue_253.py

@@ -0,0 +1,28 @@
+# A set of regression tests for open issues
+
+import cocotb
+from cocotb.triggers import Timer
+
+
+async def toggle_clock(dut):
+    dut.clk.value = 0
+    await Timer(10, "ns")
+    assert dut.clk.value.integer == 0, "Clock not set to 0 as expected"
+    dut.clk.value = 1
+    await Timer(10, "ns")
+    assert dut.clk.value.integer == 1, "Clock not set to 1 as expected"
+
+
+@cocotb.test()
+async def issue_253_empty(dut):
+    await toggle_clock(dut)
+
+
+@cocotb.test()
+async def issue_253_none(dut):
+    await toggle_clock(dut)
+
+
+@cocotb.test()
+async def issue_253_notset(dut):
+    await toggle_clock(dut)

testbed/cocotb__cocotb/tests/test_cases/issue_330/Makefile

@@ -0,0 +1,33 @@
+###############################################################################
+# Copyright (c) 2013 Potential Ventures Ltd
+# Copyright (c) 2013 SolarFlare Communications Inc
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Potential Ventures Ltd,
+#       SolarFlare Communications Inc nor the
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+###############################################################################
+
+
+include ../../designs/sample_module/Makefile
+
+MODULE = issue_330

testbed/cocotb__cocotb/tests/test_cases/issue_330/issue_330.py

@@ -0,0 +1,72 @@
+# A set of regression tests for open issues
+
+import logging
+
+import cocotb
+from cocotb._sim_versions import RivieraVersion
+
+SIM_NAME = cocotb.SIM_NAME.lower()
+
+
+# GHDL unable to access record signals (gh-2591)
+# Icarus doesn't support structs (gh-2592)
+# Verilator doesn't support structs (gh-1275)
+# Riviera-PRO 2022.10 and newer does not discover inout_if correctly over VPI (gh-3587)
+@cocotb.test(
+    expect_error=AttributeError
+    if SIM_NAME.startswith(("icarus", "ghdl", "verilator"))
+    or (
+        SIM_NAME.startswith("riviera")
+        and RivieraVersion(cocotb.SIM_VERSION) >= RivieraVersion("2022.10")
+        and cocotb.LANGUAGE == "verilog"
+    )
+    else ()
+)
+async def issue_330_direct(dut):
+    """
+    Access a structure
+    """
+
+    tlog = logging.getLogger("cocotb.test")
+
+    structure = dut.inout_if
+
+    tlog.info(
+        f"Value of inout_if => a_in = {structure.a_in.value} ; b_out = {structure.b_out.value}"
+    )
+
+
+# GHDL unable to access record signals (gh-2591)
+# Icarus doesn't support structs (gh-2592)
+# Verilator doesn't support structs (gh-1275)
+@cocotb.test(
+    expect_error=AttributeError
+    if SIM_NAME.startswith(("icarus", "ghdl"))
+    else AssertionError
+    if SIM_NAME.startswith("verilator")
+    else ()
+)
+async def issue_330_iteration(dut):
+    """
+    Access a structure via issue_330_iteration
+    """
+
+    tlog = logging.getLogger("cocotb.test")
+
+    structure = dut.inout_if
+
+    count = 0
+    for member in structure:
+        tlog.info("Found %s" % member._path)
+        count += 1
+
+    # Riviera-PRO 2022.10 and newer does not discover inout_if correctly over VPI (gh-3587)
+    rv_2022_10_plus = RivieraVersion(cocotb.SIM_VERSION) >= RivieraVersion("2022.10")
+    if (
+        SIM_NAME.startswith("riviera")
+        and rv_2022_10_plus
+        and cocotb.LANGUAGE == "verilog"
+    ):
+        assert count == 0
+    else:
+        assert count == 2, "There should have been two members of the structure"

testbed/cocotb__cocotb/tests/test_cases/issue_588/Makefile

@@ -0,0 +1,31 @@
+###############################################################################
+# Copyright (c) 2018 Potential Ventures Ltd
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Potential Ventures Ltd,
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+###############################################################################
+
+
+include ../../designs/sample_module/Makefile
+
+MODULE = issue_588

testbed/cocotb__cocotb/tests/test_cases/issue_588/issue_588.py

@@ -0,0 +1,29 @@
+# Test case for issue 588- yielding both coroutines and triggers in a list.
+# This is a very simple test; it just makes sure we can yield a list of both.
+
+import cocotb
+from cocotb import triggers, utils
+
+
+async def sample_coroutine(dut):
+    """Very simple coroutine that waits 5 ns."""
+    await triggers.Timer(5, "ns")
+    dut._log.info("Sample coroutine yielded.")
+
+
+@cocotb.test()
+async def issue_588_coroutine_list(dut):
+    """Yield a list of triggers and coroutines."""
+
+    # Record simulation time.
+    current_time = utils.get_sim_time("ns")
+
+    # Yield a list, containing a RisingEdge trigger and a coroutine.
+    coro = cocotb.start_soon(sample_coroutine(dut))
+    await triggers.First(coro, triggers.Timer(100, "ns"))
+    coro.kill()
+
+    # Make sure that only 5 ns passed, because the sample coroutine
+    # terminated first.
+    new_time = utils.get_sim_time("ns")
+    assert int(new_time - current_time) == 5, "Did not yield coroutine in list."

testbed/cocotb__cocotb/tests/test_cases/issue_768_a/Makefile

@@ -0,0 +1,3 @@
+include ../../designs/sample_module/Makefile
+
+MODULE = issue_768

testbed/cocotb__cocotb/tests/test_cases/issue_768_b/Makefile

@@ -0,0 +1,3 @@
+include ../../designs/sample_module/Makefile
+
+MODULE = issue_768

testbed/cocotb__cocotb/tests/test_cases/issue_768_b/issue_768.py

@@ -0,0 +1,21 @@
+"""
+Failing case.
+
+Note that the bug only occurred if the test in question runs first - so
+no more tests can be added to this file.
+"""
+
+import cocotb
+from cocotb.triggers import ReadOnly, Timer
+from cocotb.types import LogicArray, Range
+
+# this line is different between the two files
+value = LogicArray(0, Range(7, "downto", 0))
+
+
+@cocotb.test()
+async def do_test(dut):
+    dut.stream_in_data.setimmediatevalue(value)
+    await Timer(1, "step")
+    assert dut.stream_in_data.value == 0
+    await ReadOnly()

testbed/cocotb__cocotb/tests/test_cases/issue_857/Makefile

@@ -0,0 +1,31 @@
+###############################################################################
+# Copyright (c) 2015 Potential Ventures Ltd
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Potential Ventures Ltd,
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+###############################################################################
+
+
+include ../../designs/sample_module/Makefile
+
+MODULE = issue_857

testbed/cocotb__cocotb/tests/test_cases/issue_892/Makefile

@@ -0,0 +1,33 @@
+###############################################################################
+# Copyright (c) 2013 Potential Ventures Ltd
+# Copyright (c) 2013 SolarFlare Communications Inc
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Potential Ventures Ltd,
+#       SolarFlare Communications Inc nor the
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+###############################################################################
+
+
+include ../../designs/sample_module/Makefile
+
+MODULE = issue_892

testbed/cocotb__cocotb/tests/test_cases/test_external/Makefile

@@ -0,0 +1,33 @@
+###############################################################################
+# Copyright (c) 2013 Potential Ventures Ltd
+# Copyright (c) 2013 SolarFlare Communications Inc
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Potential Ventures Ltd,
+#       SolarFlare Communications Inc nor the
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+###############################################################################
+
+
+include ../../designs/sample_module/Makefile
+
+MODULE = test_external

testbed/cocotb__cocotb/tests/test_cases/test_iteration_vhdl/test_iteration.py

@@ -0,0 +1,158 @@
+# Copyright (c) 2015, 2018 Potential Ventures Ltd
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Potential Ventures Ltd
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import logging
+import os
+
+import cocotb
+from cocotb._sim_versions import QuestaVersion
+from cocotb.triggers import Combine, Timer
+
+
+def total_object_count():
+    """Return the total object count based on simulator."""
+    SIM_NAME = cocotb.SIM_NAME.lower()
+    SIM_VERSION = cocotb.SIM_VERSION.lower()
+
+    # Questa with VHPI
+    # TODO: Why do we get massively different numbers for Questa/VHPI than for Questa/FLI or VPI?
+    if SIM_NAME.startswith("modelsim") and os.environ["VHDL_GPI_INTERFACE"] == "vhpi":
+        return 68127
+
+    # Questa 2023.1 onwards (FLI) do not discover the following objects, which
+    # are instantiated four times:
+    # - inst_generic_sp_ram.clk (<class 'cocotb.handle.ModifiableObject'>)
+    # - inst_generic_sp_ram.rst (<class 'cocotb.handle.ModifiableObject'>)
+    # - inst_generic_sp_ram.wen (<class 'cocotb.handle.ModifiableObject'>)
+    # - inst_generic_sp_ram.en (<class 'cocotb.handle.ModifiableObject'>)
+    if (
+        SIM_NAME.startswith("modelsim")
+        and QuestaVersion(SIM_VERSION) >= QuestaVersion("2023.1")
+        and os.environ["VHDL_GPI_INTERFACE"] == "fli"
+    ):
+        return 35153 - 4 * 4
+
+    if SIM_NAME.startswith(
+        (
+            "ncsim",
+            "xmsim",
+            "modelsim",
+            "riviera",
+        )
+    ):
+        return 35153
+
+    # Active-HDL
+    if SIM_NAME.startswith("aldec"):
+        if SIM_VERSION.startswith("11.1"):
+            # Active-HDL 11.1 only finds 'inbranch_tdata_low' inside the gen_acs for generate block
+            return 27359
+        if SIM_VERSION.startswith("10.01"):
+            # Active-HDL 10.1 doesn't find any signals declared inside the gen_acs for generate block
+            return 26911
+
+    return 0
+
+
+@cocotb.test(skip=(total_object_count() == 0))
+async def recursive_discovery(dut):
+    """Recursively discover every single object in the design."""
+
+    pass_total = total_object_count()
+
+    tlog = logging.getLogger("cocotb.test")
+    await Timer(100)
+
+    def dump_all_the_things(parent):
+        if not isinstance(
+            parent,
+            (
+                cocotb.handle.HierarchyObjectBase,
+                cocotb.handle.NonHierarchyIndexableObjectBase,
+            ),
+        ):
+            return 0
+        count = 0
+        for thing in parent:
+            count += 1
+            tlog.info("Found %s (%s)", thing._path, type(thing))
+            count += dump_all_the_things(thing)
+        return count
+
+    total = dump_all_the_things(dut)
+    tlog.info("Found a total of %d things", total)
+    assert total == pass_total
+
+
+# GHDL unable to access signals in generate loops (gh-2594)
+@cocotb.test(
+    expect_error=IndexError if cocotb.SIM_NAME.lower().startswith("ghdl") else ()
+)
+async def discovery_all(dut):
+    """Discover everything on top-level."""
+    dut._log.info("Iterating over top-level to discover objects")
+    for thing in dut:
+        thing._log.info("Found something: %s", thing._path)
+
+    dut._log.info("length of dut.inst_acs is %d", len(dut.gen_acs))
+    item = dut.gen_acs[3]
+    item._log.info("this is item")
+
+
+@cocotb.test()
+async def dual_iteration(dut):
+    """Test iteration over top-level in two forked coroutines."""
+
+    async def iteration_loop():
+        for thing in dut:
+            thing._log.info("Found something: %s", thing._path)
+            await Timer(1)
+
+    loop_one = cocotb.start_soon(iteration_loop())
+    loop_two = cocotb.start_soon(iteration_loop())
+
+    await Combine(loop_one, loop_two)
+
+
+# GHDL unable to access record types (gh-2591)
+@cocotb.test(
+    expect_fail=cocotb.SIM_NAME.lower().startswith("aldec"),
+    expect_error=AttributeError if cocotb.SIM_NAME.lower().startswith("ghdl") else (),
+)
+async def test_n_dimension_array(dut):
+    """Test iteration over multi-dimensional array."""
+    tlog = logging.getLogger("cocotb.test")
+    inner_count = 0
+    outer_count = 0
+    config = dut.inst_ram_ctrl.config
+    # This signal is a 2 x 7 vhpiEnumVecVal
+    for thing in config:
+        for sub_thing in thing:
+            tlog.info("Found %s", sub_thing._name)
+            inner_count += 1
+        outer_count += 1
+
+    assert outer_count == 2, outer_count
+    assert inner_count == 14, inner_count

testbed/cocotb__cocotb/tests/test_cases/test_long_log_msg/.gitignore

@@ -0,0 +1 @@
+errlog

testbed/cocotb__cocotb/tests/test_cases/test_long_log_msg/Makefile

@@ -0,0 +1,39 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+ifeq ($(SIM),ghdl)
+
+all:
+	@echo Skipping test because GHDL does not support identifiers longer than 1023 characters.
+	@echo See also https://github.com/ghdl/ghdl/issues/1930
+
+else
+
+PROJ_DIR := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+
+TOPLEVEL_LANG ?= verilog
+
+ifeq ($(TOPLEVEL_LANG),verilog)
+VERILOG_SOURCES := $(PROJ_DIR)/test.sv
+else ifeq ($(TOPLEVEL_LANG),vhdl)
+VHDL_SOURCES := $(PROJ_DIR)/test.vhd
+endif
+
+ifneq ($(filter $(SIM),ius xcelium),)
+COMPILE_ARGS += -v93
+endif
+
+TOPLEVEL := test
+
+export MODULE := test_long_log_msg
+export COCOTB_LOG_LEVEL := DEBUG
+
+.PHONY: override_for_this_test
+override_for_this_test:
+	$(MAKE) all 2>errlog
+	! grep &>/dev/null "Log message construction failed" errlog
+
+include $(shell cocotb-config --makefiles)/Makefile.sim
+
+endif

testbed/cocotb__cocotb/tests/test_cases/test_long_log_msg/test.vhd

@@ -0,0 +1,14 @@
+-- Copyright cocotb contributors
+-- Licensed under the Revised BSD License, see LICENSE for details.
+-- SPDX-License-Identifier: BSD-3-Clause
+
+entity test is
+    port (
+        KPFIVTM1LHY0OFUNXF0XZO1RV535NNU4A8QWR12BLQXJ98PMM1P552QC0T089PUJPB4POUJZLBS19S8XNMPGJV2QK3AJUW98X7RU56ZV4IMFIPDJI81E5B9HNW94Q9APLMMK3VPHS1VB1QVPQDG7VOTLY2NT3F4080OUXSC68H0JZF7KQ0O6GGN3DARXC03CSZL7TE6B7R47366SB54T5Q4MOR5BT3L5S0S3NM8MALXPHZKCUA6AR5U391GGDYG5LB7JGKAHSIREODSNGW7FAYNRTTXFFCRL4U3ZQA6DH1RKCFKGDG9WMF81IX5YSAINQSP14F2FJV0GYEM3R4LUFFSWOZKK5MGKS25RLROJFEQDC8L2XY07728MM7V516ZXH1YFS0AL1GPLH03N5EL0RQVY61EVEQEJCYDT0ZBBN1ZLC5BDQU83NF8N953MU6A99SDNPCTSOD2W9WY69ZL64JHURFHA5DT7KQC7T4KASR5CAG85ONU3F2XWYA97JHDN9V9SBS39MYMYERJ338O6JQYCHX7SH8FB2VL2PI7DOQWB3NXTA8CQM7YKT34L6U3O42WWMI7NHKUIBO4U9MBP176000FU39WET32RG4PHLYYGWFMKPYPCUFE46RFSQDELLXU31ZZH0OJCGEFUDR2USDUYZ3XPBQ6RC0XARPG2Z1GHCESILHJOF7503PHKWUKDVM2V18WB16CB7AAQ8C4C6E7FXUB3E89Q0ZJSKQFYNZPSKYKGXURV3V5C0SHU9QQ2GFUTP38ORCSWN0QYIX9H0SKJEXPC5U1D3QN9PRT0QPOVM7H5EGQ4E449YTSHUMJW1TT2S6EVIPPIR9ZMFCOWPYXRSNJEQ3OCKGDUW2ZX2AS7N5GBUY7NOAR2P7BK5YPOA6APVAH12V86V2YQZ2M56HLNAD785GI4GMFSCI5P3LNFM0CLSBUEJXCVT695N5D3GC8T0HKAN0BZDV1ZMI0WZ3QUVABNYFOJHXXBUW5OK5MQ46NMK3W0FMCKWVPP6265 : in integer;
+        o : out integer);
+end entity test;
+
+architecture rtl of test is
+begin
+    o <= KPFIVTM1LHY0OFUNXF0XZO1RV535NNU4A8QWR12BLQXJ98PMM1P552QC0T089PUJPB4POUJZLBS19S8XNMPGJV2QK3AJUW98X7RU56ZV4IMFIPDJI81E5B9HNW94Q9APLMMK3VPHS1VB1QVPQDG7VOTLY2NT3F4080OUXSC68H0JZF7KQ0O6GGN3DARXC03CSZL7TE6B7R47366SB54T5Q4MOR5BT3L5S0S3NM8MALXPHZKCUA6AR5U391GGDYG5LB7JGKAHSIREODSNGW7FAYNRTTXFFCRL4U3ZQA6DH1RKCFKGDG9WMF81IX5YSAINQSP14F2FJV0GYEM3R4LUFFSWOZKK5MGKS25RLROJFEQDC8L2XY07728MM7V516ZXH1YFS0AL1GPLH03N5EL0RQVY61EVEQEJCYDT0ZBBN1ZLC5BDQU83NF8N953MU6A99SDNPCTSOD2W9WY69ZL64JHURFHA5DT7KQC7T4KASR5CAG85ONU3F2XWYA97JHDN9V9SBS39MYMYERJ338O6JQYCHX7SH8FB2VL2PI7DOQWB3NXTA8CQM7YKT34L6U3O42WWMI7NHKUIBO4U9MBP176000FU39WET32RG4PHLYYGWFMKPYPCUFE46RFSQDELLXU31ZZH0OJCGEFUDR2USDUYZ3XPBQ6RC0XARPG2Z1GHCESILHJOF7503PHKWUKDVM2V18WB16CB7AAQ8C4C6E7FXUB3E89Q0ZJSKQFYNZPSKYKGXURV3V5C0SHU9QQ2GFUTP38ORCSWN0QYIX9H0SKJEXPC5U1D3QN9PRT0QPOVM7H5EGQ4E449YTSHUMJW1TT2S6EVIPPIR9ZMFCOWPYXRSNJEQ3OCKGDUW2ZX2AS7N5GBUY7NOAR2P7BK5YPOA6APVAH12V86V2YQZ2M56HLNAD785GI4GMFSCI5P3LNFM0CLSBUEJXCVT695N5D3GC8T0HKAN0BZDV1ZMI0WZ3QUVABNYFOJHXXBUW5OK5MQ46NMK3W0FMCKWVPP6265;
+end architecture rtl;

testbed/cocotb__cocotb/tests/test_cases/test_long_log_msg/test_long_log_msg.py

@@ -0,0 +1,10 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+import cocotb
+
+
+@cocotb.test()
+async def test_access_long_name(dut):
+    dut.KPFIVTM1LHY0OFUNXF0XZO1RV535NNU4A8QWR12BLQXJ98PMM1P552QC0T089PUJPB4POUJZLBS19S8XNMPGJV2QK3AJUW98X7RU56ZV4IMFIPDJI81E5B9HNW94Q9APLMMK3VPHS1VB1QVPQDG7VOTLY2NT3F4080OUXSC68H0JZF7KQ0O6GGN3DARXC03CSZL7TE6B7R47366SB54T5Q4MOR5BT3L5S0S3NM8MALXPHZKCUA6AR5U391GGDYG5LB7JGKAHSIREODSNGW7FAYNRTTXFFCRL4U3ZQA6DH1RKCFKGDG9WMF81IX5YSAINQSP14F2FJV0GYEM3R4LUFFSWOZKK5MGKS25RLROJFEQDC8L2XY07728MM7V516ZXH1YFS0AL1GPLH03N5EL0RQVY61EVEQEJCYDT0ZBBN1ZLC5BDQU83NF8N953MU6A99SDNPCTSOD2W9WY69ZL64JHURFHA5DT7KQC7T4KASR5CAG85ONU3F2XWYA97JHDN9V9SBS39MYMYERJ338O6JQYCHX7SH8FB2VL2PI7DOQWB3NXTA8CQM7YKT34L6U3O42WWMI7NHKUIBO4U9MBP176000FU39WET32RG4PHLYYGWFMKPYPCUFE46RFSQDELLXU31ZZH0OJCGEFUDR2USDUYZ3XPBQ6RC0XARPG2Z1GHCESILHJOF7503PHKWUKDVM2V18WB16CB7AAQ8C4C6E7FXUB3E89Q0ZJSKQFYNZPSKYKGXURV3V5C0SHU9QQ2GFUTP38ORCSWN0QYIX9H0SKJEXPC5U1D3QN9PRT0QPOVM7H5EGQ4E449YTSHUMJW1TT2S6EVIPPIR9ZMFCOWPYXRSNJEQ3OCKGDUW2ZX2AS7N5GBUY7NOAR2P7BK5YPOA6APVAH12V86V2YQZ2M56HLNAD785GI4GMFSCI5P3LNFM0CLSBUEJXCVT695N5D3GC8T0HKAN0BZDV1ZMI0WZ3QUVABNYFOJHXXBUW5OK5MQ46NMK3W0FMCKWVPP6265

testbed/cocotb__cocotb/tests/test_cases/test_module_var_empty/Makefile

@@ -0,0 +1,15 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# test MODULE is empty
+# should cause regression initialization failure so no results.xml is written
+
+MODULE := " "
+
+.PHONY: override_for_this_test
+override_for_this_test:
+	-$(MAKE) all
+	@test ! -f $(COCOTB_RESULTS_FILE)
+
+include ../../designs/sample_module/Makefile

testbed/cocotb__cocotb/tests/test_cases/test_module_var_messy/Makefile

@@ -0,0 +1,15 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# test MODULE contains leading and trailing separators
+# should cause regression initialization failure so no results.xml is written
+
+MODULE=" , test_nothing  ,"
+
+.PHONY: override_for_this_test
+override_for_this_test:
+	-$(MAKE) all
+	@test ! -f $(COCOTB_RESULTS_FILE)
+
+include ../../designs/sample_module/Makefile

testbed/cocotb__cocotb/tests/test_cases/test_module_var_messy/test_nothing.py

@@ -0,0 +1 @@
+""" This test module is purposefully empty """

testbed/cocotb__cocotb/tests/test_cases/test_module_without_tests/Makefile

@@ -0,0 +1,15 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# test MODULE is set
+# should cause regression initialization failure so no results.xml is written
+
+MODULE=test_nothing
+
+.PHONY: override_for_this_test
+override_for_this_test:
+	-$(MAKE) all
+	@test ! -f $(COCOTB_RESULTS_FILE)
+
+include ../../designs/sample_module/Makefile

testbed/cocotb__cocotb/tests/test_cases/test_multi_dimension_array/test_cocotb_array.py

@@ -0,0 +1,185 @@
+import cocotb
+from cocotb.triggers import Timer
+
+SIM_NAME = cocotb.SIM_NAME.lower()
+
+
+@cocotb.test()
+async def test_in_vect_packed(dut):
+    test_value = 0x5
+    dut.in_vect_packed.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_vect_packed.value == test_value
+
+
+# Verilator combines 1-dimensional unpacked arrays into a single vector (gh-3611)
+@cocotb.test(expect_error=TypeError if SIM_NAME.startswith("verilator") else ())
+async def test_in_vect_unpacked(dut):
+    test_value = [0x1, 0x0, 0x1]
+    dut.in_vect_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_vect_unpacked.value == test_value
+
+
+@cocotb.test()
+async def test_in_arr(dut):
+    test_value = 0x5
+    dut.in_arr.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_arr.value == test_value
+
+
+@cocotb.test()
+async def test_in_2d_vect_packed_packed(dut):
+    test_value = (0x5 << 6) | (0x5 << 3) | 0x5
+    dut.in_2d_vect_packed_packed.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_2d_vect_packed_packed.value == test_value
+
+
+@cocotb.test()
+async def test_in_2d_vect_packed_unpacked(dut):
+    test_value = [0x5, 0x5, 0x5]
+    dut.in_2d_vect_packed_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_2d_vect_packed_unpacked.value == test_value
+
+
+# Verilator doesn't support multi-dimensional unpacked arrays (gh-3611)
+@cocotb.test(expect_error=AttributeError if SIM_NAME.startswith("verilator") else ())
+async def test_in_2d_vect_unpacked_unpacked(dut):
+    test_value = 3 * [[0x1, 0x0, 0x1]]
+    dut.in_2d_vect_unpacked_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_2d_vect_unpacked_unpacked.value == test_value
+
+
+@cocotb.test()
+async def test_in_arr_packed(dut):
+    test_value = 365
+    dut.in_arr_packed.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_arr_packed.value == test_value
+
+
+@cocotb.test()
+async def test_in_arr_unpacked(dut):
+    test_value = [0x5, 0x5, 0x5]
+    dut.in_arr_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_arr_unpacked.value == test_value
+
+
+@cocotb.test()
+async def test_in_2d_arr(dut):
+    test_value = 365
+    dut.in_2d_arr.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_2d_arr.value == test_value
+
+
+@cocotb.test()
+async def test_in_vect_packed_packed_packed(dut):
+    test_value = 95869805
+    dut.in_vect_packed_packed_packed.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_vect_packed_packed_packed.value == test_value
+
+
+# Questa is unable to access elements of a logic array if the last dimension is unpacked (gh-2605)
+# Verilator doesn't support multi-dimensional unpacked arrays (gh-3611)
+@cocotb.test(
+    expect_error=IndexError
+    if cocotb.LANGUAGE == "verilog" and SIM_NAME.startswith("modelsim")
+    else AttributeError
+    if SIM_NAME.startswith("verilator")
+    else ()
+)
+async def test_in_vect_packed_packed_unpacked(dut):
+    test_value = [365, 365, 365]
+    dut.in_vect_packed_packed_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_vect_packed_packed_unpacked.value == test_value
+
+
+# Verilator doesn't support multi-dimensional unpacked arrays (gh-3611)
+@cocotb.test(expect_error=AttributeError if SIM_NAME.startswith("verilator") else ())
+async def test_in_vect_packed_unpacked_unpacked(dut):
+    test_value = 3 * [3 * [5]]
+    dut.in_vect_packed_unpacked_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_vect_packed_unpacked_unpacked.value == test_value
+
+
+# Verilator doesn't support multi-dimensional unpacked arrays (gh-3611)
+@cocotb.test(expect_error=AttributeError if SIM_NAME.startswith("verilator") else ())
+async def test_in_vect_unpacked_unpacked_unpacked(dut):
+    test_value = 3 * [3 * [[1, 0, 1]]]
+    dut.in_vect_unpacked_unpacked_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_vect_unpacked_unpacked_unpacked.value == test_value
+
+
+@cocotb.test()
+async def test_in_arr_packed_packed(dut):
+    test_value = (365 << 18) | (365 << 9) | (365)
+    dut.in_arr_packed_packed.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_arr_packed_packed.value == test_value
+
+
+# Questa is unable to access elements of a logic array if the last dimension is unpacked (gh-2605)
+# Verilator doesn't support multi-dimensional unpacked arrays (gh-3611)
+@cocotb.test(
+    expect_error=IndexError
+    if cocotb.LANGUAGE == "verilog" and SIM_NAME.startswith("modelsim")
+    else AttributeError
+    if SIM_NAME.startswith("verilator")
+    else ()
+)
+async def test_in_arr_packed_unpacked(dut):
+    test_value = [365, 365, 365]
+    dut.in_arr_packed_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_arr_packed_unpacked.value == test_value
+
+
+# Verilator doesn't support multi-dimensional unpacked arrays (gh-3611)
+@cocotb.test(expect_error=AttributeError if SIM_NAME.startswith("verilator") else ())
+async def test_in_arr_unpacked_unpacked(dut):
+    test_value = 3 * [3 * [5]]
+    dut.in_arr_unpacked_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_arr_unpacked_unpacked.value == test_value
+
+
+@cocotb.test()
+async def test_in_2d_arr_packed(dut):
+    test_value = (365 << 18) | (365 << 9) | (365)
+    dut.in_2d_arr_packed.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_2d_arr_packed.value == test_value
+
+
+# Questa is unable to access elements of a logic array if the last dimension is unpacked (gh-2605)
+# Verilator doesn't support multi-dimensional unpacked arrays (gh-3611)
+@cocotb.test(
+    expect_error=IndexError
+    if cocotb.LANGUAGE == "verilog" and SIM_NAME.startswith("modelsim")
+    else AttributeError
+    if SIM_NAME.startswith("verilator")
+    else ()
+)
+async def test_in_2d_arr_unpacked(dut):
+    test_value = [365, 365, 365]
+    dut.in_2d_arr_unpacked.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_2d_arr_unpacked.value == test_value
+
+
+@cocotb.test()
+async def test_in_3d_arr(dut):
+    test_value = (365 << 18) | (365 << 9) | (365)
+    dut.in_3d_arr.value = test_value
+    await Timer(1, "ns")
+    assert dut.out_3d_arr.value == test_value

testbed/cocotb__cocotb/tests/test_cases/test_multi_level_module_path/Makefile

@@ -0,0 +1,11 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# test MODULE contains a multi-level Python module path, separated by period
+
+MODULE = test_package.test_module_path
+
+export PYTHONPATH := .
+
+include ../../designs/sample_module/Makefile

testbed/cocotb__cocotb/tests/test_cases/test_multi_level_module_path/test_package/test_module_path.py

@@ -0,0 +1,12 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+"""Test for multi-level module path in MODULE"""
+
+import cocotb
+
+
+@cocotb.test()
+async def test_pass(_):
+    pass

testbed/cocotb__cocotb/tests/test_cases/test_package/Makefile

@@ -0,0 +1,46 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+ifeq ($(SIM),)
+USING_ICARUS := 1
+endif
+
+ifeq ($(shell echo $(SIM) | tr A-Z a-z),icarus)
+USING_ICARUS := 1
+endif
+
+ifneq ($(USING_ICARUS),)
+ICARUS_MIN := 12.0
+ICARUS_VERSION := $(shell iverilog -V 2>/dev/null | head -n1 | cut -d ' ' -f 4)
+MIN_VERSION := $(shell printf "%s\n%s\n" "$(ICARUS_MIN)" "$(ICARUS_VERSION)" | sort -g | head -1)
+ifneq ($(MIN_VERSION),$(ICARUS_MIN))
+SKIP := 1
+$(info "Skipping test_defaultless_parameter since icarus < v12.0 doesn't support vpiInstance iteration")
+endif
+endif
+
+TOPLEVEL_LANG ?= verilog
+ifneq ($(TOPLEVEL_LANG),verilog)
+SKIP := 1
+$(info "Skipping . . . Verilog only")
+endif
+
+ifeq ($(SKIP),)
+
+VERILOG_SOURCES = cocotb_package_pkg.sv \
+                  cocotb_package.sv
+TOPLEVEL := cocotb_package
+MODULE = test_package
+
+include $(shell cocotb-config --makefiles)/Makefile.sim
+
+else
+
+all:
+	@echo "Skipping test_package"
+
+clean::
+# nothing to clean, just define target in this branch
+
+endif

testbed/cocotb__cocotb/tests/test_cases/test_package/cocotb_package.sv

@@ -0,0 +1,11 @@
+// Copyright cocotb contributors
+// Licensed under the Revised BSD License, see LICENSE for details.
+// SPDX-License-Identifier: BSD-3-Clause
+
+module cocotb_package;
+    // Necessary for Xcelium and Riviera in order for compiled packages to be visible
+    import cocotb_package_pkg_1::*;
+    import cocotb_package_pkg_2::*;
+
+    parameter int seven_int = 7;
+endmodule

testbed/cocotb__cocotb/tests/test_cases/test_package/test_package.py

@@ -0,0 +1,60 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+"""
+A set of tests that demonstrate package access
+"""
+
+import logging
+
+import cocotb
+from cocotb.result import TestSuccess
+
+
+@cocotb.test()
+async def test_params(dut):
+    """Test package parameter access"""
+    tlog = logging.getLogger("cocotb.test")
+
+    tlog.info("Checking Parameters:")
+    assert dut.seven_int.value == 7
+    pkg1 = cocotb.packages.cocotb_package_pkg_1
+    assert pkg1.five_int.value == 5
+    assert pkg1.eight_logic.value == 8
+    pkg2 = cocotb.packages.cocotb_package_pkg_2
+    assert pkg2.eleven_int.value == 11
+
+
+@cocotb.test()
+async def test_stringification(dut):
+    """Test package stringification"""
+    tlog = logging.getLogger("cocotb.test")
+
+    tlog.info("Checking Strings:")
+    pkg1 = cocotb.packages.cocotb_package_pkg_1
+    assert str(pkg1).startswith("HierarchyObject(cocotb_package_pkg_1")
+    assert str(pkg1.five_int) == "LogicObject(cocotb_package_pkg_1::five_int)"
+    assert str(pkg1.eight_logic) == "LogicObject(cocotb_package_pkg_1::eight_logic)"
+    pkg2 = cocotb.packages.cocotb_package_pkg_2
+    assert str(pkg2).startswith("HierarchyObject(cocotb_package_pkg_2")
+    assert str(pkg2.eleven_int) == "LogicObject(cocotb_package_pkg_2::eleven_int)"
+
+
+@cocotb.test()
+async def test_dollar_unit(dut):
+    """Test $unit scope"""
+    tlog = logging.getLogger("cocotb.test")
+
+    if cocotb.SIM_NAME.lower().startswith("riviera"):
+        tlog.info("Riviera does not support $unit access via vpiInstance")
+        raise TestSuccess
+
+    tlog.info("Checking $unit:")
+    # Is $unit even a package?  Xcelium says yes and 37.10 detail 5 would also suggest yes
+    pkgs = vars(cocotb.packages).keys()
+    f = filter(lambda x: "unit" in x, pkgs)
+    unit = list(f)[0]
+    tlog.info(f"Found $unit as {unit}")
+    unit_pkg = getattr(cocotb.packages, unit)
+    assert unit_pkg.unit_four_int.value == 4

testbed/cocotb__cocotb/tests/test_cases/test_packed_union/Makefile

@@ -0,0 +1,21 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+TOPLEVEL_LANG ?= verilog
+
+ifneq ($(TOPLEVEL_LANG),verilog)
+
+all:
+	@echo "Skipping test due to TOPLEVEL_LANG=$(TOPLEVEL_LANG) not being verilog"
+clean::
+
+else
+
+VERILOG_SOURCES = test_packed_union.sv
+TOPLEVEL = test_packed_union
+MODULE = test_packed_union
+
+include $(shell cocotb-config --makefiles)/Makefile.sim
+
+endif

testbed/cocotb__cocotb/tests/test_cases/test_packed_union/test_packed_union.py

@@ -0,0 +1,21 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+import cocotb
+from cocotb._sim_versions import RivieraVersion
+
+
+# Riviera-PRO 2022.10 (VPI) and newer does not discover dut.t correctly (gh-3587)
+@cocotb.test(
+    expect_error=Exception
+    if cocotb.SIM_NAME.lower().startswith(("verilator", "icarus", "ghdl"))
+    or (
+        cocotb.SIM_NAME.lower().startswith("riviera")
+        and RivieraVersion(cocotb.SIM_VERSION) >= RivieraVersion("2022.10")
+        and cocotb.LANGUAGE == "verilog"
+    )
+    else ()
+)
+async def test_packed_union(dut):
+    dut.t.a.value = 0

testbed/cocotb__cocotb/tests/test_cases/test_packed_union/test_packed_union.sv

@@ -0,0 +1,12 @@
+/**
+ * Copyright cocotb contributors
+ * Licensed under the Revised BSD License, see LICENSE for details.
+ * SPDX-License-Identifier: BSD-3-Clause
+*/
+
+module test_packed_union
+    (input union packed {
+           logic [3:0] a;
+           logic [1:0][1:0] b;
+     } t);
+endmodule : test_packed_union

testbed/cocotb__cocotb/tests/test_cases/test_plusargs/plusargs.py

@@ -0,0 +1,44 @@
+# Copyright (c) 2013 Potential Ventures Ltd
+# Copyright (c) 2013 SolarFlare Communications Inc
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Potential Ventures Ltd,
+#       SolarFlare Communications Inc nor the
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+"""
+    plusarg testing
+"""
+
+import cocotb
+
+
+@cocotb.test()
+async def plusargs_test(dut):
+    """Demonstrate plusarg access from Python test"""
+
+    for name in cocotb.plusargs:
+        print("COCOTB:", name, cocotb.plusargs[name])
+
+    assert "test1" in cocotb.plusargs
+    assert cocotb.plusargs["foo"] == "bar"
+    assert cocotb.plusargs["lol"] == "wow=4"

testbed/cocotb__cocotb/tests/test_cases/test_seed/Makefile

@@ -0,0 +1,10 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+run:
+	$(RM) number
+	$(MAKE) sim MODULE=test_other,test_seed RANDOM_SEED=1234
+	$(MAKE) sim MODULE=test_seed TESTCASE=test_reproducibility RANDOM_SEED=1234
+
+include ../../designs/sample_module/Makefile

testbed/cocotb__cocotb/tests/test_cases/test_seed/test_other.py

@@ -0,0 +1,11 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+import cocotb
+
+
+@cocotb.test()
+async def test_pass(_):
+    # exists solely so there is another test in another module
+    # before the other module is run
+    pass

testbed/cocotb__cocotb/tests/test_cases/test_seed/test_seed.py

@@ -0,0 +1,25 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+import random
+
+import cocotb
+
+
+@cocotb.test()
+async def test_first(_):
+    # move generator to test that it doesn't affect the next test
+    for _ in range(100):
+        random.getrandbits(64)
+
+
+@cocotb.test()
+async def test_reproducibility(_):
+    try:
+        with open("number") as file:
+            a = int(file.read())
+        assert a == random.getrandbits(32)
+    except FileNotFoundError:
+        with open("number", "w") as file:
+            number = random.getrandbits(32)
+            file.write(str(number))

testbed/cocotb__cocotb/tests/test_cases/test_select_testcase/Makefile

@@ -0,0 +1,10 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# select only y_tests from all MODULEs
+
+include ../../designs/sample_module/Makefile
+
+MODULE := x_tests,y_tests,y_tests_again
+TESTCASE := y_test

testbed/cocotb__cocotb/tests/test_cases/test_select_testcase/x_tests.py

@@ -0,0 +1,6 @@
+import cocotb
+
+
+@cocotb.test()
+async def x_test(dut):
+    assert False

testbed/cocotb__cocotb/tests/test_cases/test_select_testcase/y_tests.py

@@ -0,0 +1,6 @@
+import cocotb
+
+
+@cocotb.test()
+async def y_test(dut):
+    pass

testbed/cocotb__cocotb/tests/test_cases/test_select_testcase/y_tests_again.py

@@ -0,0 +1,6 @@
+import cocotb
+
+
+@cocotb.test()
+async def y_test(dut):
+    pass

testbed/cocotb__cocotb/tests/test_cases/test_select_testcase_error/Makefile

@@ -0,0 +1,12 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# This module exists, but...
+MODULE := x_tests
+# ...this test does not exist
+TESTCASE := y_test
+
+# TESTCASE filtering out all tests results in a warning
+
+include ../../designs/sample_module/Makefile

testbed/cocotb__cocotb/tests/test_cases/test_select_testcase_error/x_tests.py

@@ -0,0 +1,6 @@
+import cocotb
+
+
+@cocotb.test()
+async def x_test(dut):
+    dut._log.info("x_test")

testbed/cocotb__cocotb/tests/test_cases/test_skipped/Makefile

@@ -0,0 +1,22 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+include ../../designs/sample_module/Makefile
+
+SKIPPED_TEST_FILE = ran_skipped_test~
+
+clean::
+	$(RM) -r ${SKIPPED_TEST_FILE}
+
+# Override the default target. We need to run clean (to remove the cached test file)
+# and then test to make sure it is recreated.
+.DEFAULT_GOAL := override
+.PHONY: override
+override: clean all
+	 @test -f $(SKIPPED_TEST_FILE) || (echo "ERROR: skip=True test was not ran!" >&2 && exit 1)
+
+# Set TESTCASE; run test_skipped even though skip=True is set.
+TESTCASE = test_skipped
+
+MODULE = test_skipped

testbed/cocotb__cocotb/tests/test_cases/test_skipped/test_skipped.py

@@ -0,0 +1,15 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+import pathlib
+
+import cocotb
+
+skipped_file_name = "ran_skipped_test~"
+
+
+@cocotb.test(skip=True)
+async def test_skipped(dut):
+    """Touch a file so we can check that this test has run."""
+    pathlib.Path(skipped_file_name).touch()

testbed/cocotb__cocotb/tests/test_cases/test_sv_interface/Makefile

@@ -0,0 +1,28 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+TOPLEVEL_LANG ?= verilog
+VERILOG_SOURCES = $(shell pwd)/top.sv
+MODULE = test_sv_if
+TOPLEVEL = top
+
+# Simulator behavior:
+# Icarus Verilog sees SV interfaces as vpiModule but doesn't discover signals inside them
+# Verilator sees SV interfaces as vpiModule and discovers signals inside them
+# Commercial simulators all see SV interfaces as vpiInterface and discover signals inside them
+
+
+ifneq ($(TOPLEVEL_LANG),verilog)
+all:
+	@echo "Skipping test due to TOPLEVEL_LANG=$(TOPLEVEL_LANG) not being verilog"
+clean::
+else
+ifeq ($(filter questa xcelium ius vcs riviera activehdl verilator,$(shell echo $(SIM) | tr A-Z a-z)),)
+all::
+	@echo "Skipping simulator $(SIM) because it might not support SV interfaces"
+clean::
+else
+include $(shell cocotb-config --makefiles)/Makefile.sim
+endif
+endif

testbed/cocotb__cocotb/tests/test_cases/test_sv_interface/test_sv_if.py

@@ -0,0 +1,15 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+import cocotb
+
+
+@cocotb.test()
+async def test_sv_if(dut):
+    """Test that signals in an interface are discovered and iterable"""
+
+    dut.sv_if_i._discover_all()
+    assert hasattr(dut.sv_if_i, "a")
+    assert hasattr(dut.sv_if_i, "b")
+    assert hasattr(dut.sv_if_i, "c")

testbed/cocotb__cocotb/tests/test_cases/test_sv_interface/top.sv

@@ -0,0 +1,17 @@
+// Copyright cocotb contributors
+// Licensed under the Revised BSD License, see LICENSE for details.
+// SPDX-License-Identifier: BSD-3-Clause
+
+`timescale 1us/1us
+
+interface sv_if();
+  logic a;
+  reg b;
+  wire c;
+endinterface
+
+module top ();
+
+sv_if sv_if_i();
+
+endmodule