github.com/canonical/ubuntu-image@v0.0.0-20240430122802-2202fe98b290/tests/lib/external/snapd-testing-tools/README.md (about)

     1  [![Snapcraft](https://avatars2.githubusercontent.com/u/19532717?s=200)](https://snapcraft.io)
     2  
     3  # Welcome to snapd-testing-tools
     4  
     5  This is the code repository for **snapd-testing-tools**, the set of tools
     6  used by snapd for testing porpuses. 
     7  
     8  The tools in this project are designed and tested independently, making them easy
     9  to be imported and used by any project.
    10  
    11  ## Get involved
    12  
    13  This is an [open source](COPYING) project and we warmly welcome community
    14  contributions, suggestions, and constructive feedback. If you're interested in
    15  contributing, please take a look at our [Code of Conduct](CODE_OF_CONDUCT.md)
    16  first.
    17  
    18  - to report an issue, please file [a bug
    19    report](https://bugs.launchpad.net/snappy/+filebug) on our [Launchpad issue
    20  tracker](https://bugs.launchpad.net/snappy/)
    21  - for suggestions and constructive feedback, create a post on the [Snapcraft
    22    forum](https://forum.snapcraft.io/c/snapd)
    23  
    24  ## Get in touch
    25  
    26  We're friendly! We have a community forum at
    27  [https://forum.snapcraft.io](https://forum.snapcraft.io) where we discuss
    28  feature plans, development news, issues, updates and troubleshooting. You can
    29  chat in realtime with the snapd team and our wider community on the
    30  [#snappy](https://web.libera.chat?channel=#snappy) IRC channel on
    31  [libera chat](https://libera.chat/).
    32  
    33  For news and updates, follow us on [Twitter](https://twitter.com/snapcraftio)
    34  and on [Facebook](https://www.facebook.com/snapcraftio).
    35  
    36  ## Adding new tools
    37  
    38  The tools included in this project are intended to be reused by other projects.
    39  
    40  Tools are supported in all the systems included in spread.yaml file.
    41  
    42  Read the following considerations before adding new tools:
    43  
    44   - Each tool needs to be accompanied by at least 1 spread test in `tests/<tool-name>/`
    45   - At least 1 spread test needs to be included in the tests directory for each tool
    46   - If the tool is a shell script, it needs to first pass a [ShellCheck](https://github.com/koalaman/shellcheck) assessment
    47   - All tools need to be as generic as possible
    48   - Each tool must also provide a command line interface (CLI), including _help_ output
    49  
    50  ## Adding new utils
    51  
    52  The utils included in this project are intended to be reused by other projects.
    53  
    54  Utils are used as a complement for spread tests executions. Those are not intended to be used by spread tests.
    55  For example utils are used on github action workflows to analyze tests code and outputs.
    56  
    57  Utils are supported in ubuntu-18.04 and higher.
    58  
    59  Read the following considerations before adding new utils:
    60  
    61   - Each util needs to be accompanied by at least 1 spread test in `tests/<util-name>/`
    62   - At least 1 spread test needs to be included in the tests directory for each util
    63   - If the util is a shell script, it needs to first pass a [ShellCheck](https://github.com/koalaman/shellcheck) assessment
    64   - All utils need to be as generic as possible
    65   - Each util must also provide a command line interface (CLI), including _help_ output
    66  
    67  
    68  ## Project status
    69  
    70  | Service | Status |
    71  |-----|:---|
    72  | [Github Actions](https://github.com/actions/) |  ![Build Status][actions-image]  |
    73  
    74  [actions-image]: https://github.com/snapcore/snapd-testing-tools/actions