{"id":44419255,"url":"https://github.com/trento-project/checks","last_synced_at":"2026-02-12T09:09:42.760Z","repository":{"id":253109667,"uuid":"842411731","full_name":"trento-project/checks","owner":"trento-project","description":"Checks for Trento to be executed by Wanda. Previously part of Wanda itself","archived":false,"fork":false,"pushed_at":"2025-11-28T14:14:16.000Z","size":179,"stargazers_count":1,"open_issues_count":4,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-11-30T18:16:20.042Z","etag":null,"topics":["dsl","hacktoberfest","yaml"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trento-project.png","metadata":{"files":{"readme":"README.adoc","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.adoc","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-14T09:48:39.000Z","updated_at":"2025-11-28T14:11:52.000Z","dependencies_parsed_at":"2025-01-14T14:36:06.083Z","dependency_job_id":"49906006-66d3-4b19-91af-6645b0e26acd","html_url":"https://github.com/trento-project/checks","commit_stats":null,"previous_names":["trento-project/checks"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/trento-project/checks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trento-project%2Fchecks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trento-project%2Fchecks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trento-project%2Fchecks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trento-project%2Fchecks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trento-project","download_url":"https://codeload.github.com/trento-project/checks/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trento-project%2Fchecks/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29362246,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T08:51:36.827Z","status":"ssl_error","status_checked_at":"2026-02-12T08:51:26.849Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dsl","hacktoberfest","yaml"],"created_at":"2026-02-12T09:09:42.070Z","updated_at":"2026-02-12T09:09:42.753Z","avatar_url":"https://github.com/trento-project.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Trento Checks\n\nTrento Checks are the way Trento provides continous infractructure\ncompliance.\n\nThey are implemented with a declarative, YAML-based DSL aiming at\nexpressing some expectations on the configuration of a target system, or\na group of target systems.\n\nThe Checks are then executed by our Trento checks engine,\nhttps://github.com/trento-project/wanda[Wanda].\n\n== Usage\n\nThe Checks code was originally hosted together with Wanda itself and\nonly later decoupled in this repository, so most of the related\ndocumentation will remain\nhttps://github.com/trento-project/wanda/blob/main/guides/[there] until\nmigrated somewhere else (if ever).\n\nYou can start learning more by consulting the\nhttps://github.com/trento-project/wanda/blob/main/guides/specification.adoc[specification\ndocument] # Developing Checks\n\nWanda architecture aims to simplify\nhttps://github.com/trento-project/wanda/blob/main/README.adoc#testing-executions[testing\nChecks Executions] and link:#adding-new-checks[adding new ones].\n\n== Requirements\n\n* https://www.gnu.org/software/make/manual/make.html[Make]\n* https://www.docker.com/products/cli/[Docker CLI] or https://podman-desktop.io/docs/migrating-from-docker/managing-docker-compatibility[Podman]\nusing the Docker compatibility feature\n* https://asdf-vm.com/guide/getting-started.html[Asdf]\n\n== Setup\n\n[source,sh]\n----\n# add all rered plugins\nasdf plugin add bats jq shellcheck shfmt\n# install development software\nasdf install\n----\n\n== Starting a local environment\n\nStart the environment with:\n\n[source,bash]\n----\n$ docker-compose up -d\n----\n\nWanda is exposed on port `+4000+` and the API documentation is available\nat http://localhost:4000/swaggerui\n\n*Note* that the https://www.rabbitmq.com/[message broker] *must* be\nreachable by Wanda and all the targets.\n\n== Adding new Checks\n\nBuilt-in Checks can be found in the Catalog directory at `+./checks/+`\n\nTo implement new checks and test them:\n\n* write a new\nhttps://github.com/trento-project/wanda/blob/main/guides/specification.adoc[Check\nSpecification] file\n* locate the newly created Check in the Catalog directory `+./checks/+`\n* test the execution as\nhttps://github.com/trento-project/wanda/blob/main/README.adoc#testing-executions[described\nin the check engine]\n\n== Static code analysis\n\n[source,sh]\n----\n# run tlint on checks\n# https://github.com/trento-project/tlint\nmake lint\n\n# lint on shell scripts\nmake shellcheck\n\n# format shell scripts and tests\nmake shfmt\n----\n\n== Tests\n\nThe `+./test+` folder contains the test suites for the checks catalog.\n\n[source,sh]\n----\n# Run tests against the local environment\nmake test\n\n# Customize the environment URLs\nWANDA_URL=http://wanda.example \\\n  FACTS_SERVICE_URL=amqp://user:pwd@rabbitmq.example:5672 \\\n  make test\n----\n\n=== Write a test\n\nTests are written in `+bash+` scripting using the\nhttps://bats-core.readthedocs.io/en/stable/[Bats] test framework.\n\nA test suite is a file with `+.bats+` extension and they should be named\nafter the check that is the subject of the test (for example,\n`+test/156F64.bats+` contains the tests for the check\n`+checks/156F64.yaml+`).\n\nEvery `+.bats+` file under `+./test+` folder is executed.\n\nThe anatomy of a typical test is: * an instance of Trento agent that\nsimulates the exepcted behaviour is spinned-up with a known agent id; *\nthe instance must connect to the running development environment (Wanda\nand RabbitMQ); * a check execution is requested to Wanda for the current\ncheck on the given agent id; * the check result is requested to Wanda *\nthe check result is evaluated by the test script according to the\nexpectations * the Trento agent instance is tore down.\n\n=== Test fixtures\n\nTo simulate different Trento agent behaviours, a containerized version\nis provided by https://github.com/trento-project/barbecue[Trento\nBarbecue], which defines file-based, ephemeral execution contexts for\nthe Trento agent.\n\nThe `+./test/fixtures+` folder contains a folder for each scenario we\nwant to test our checks against.\n\nTo create a new fixture: * create a folder named by the fixture; * add\nall files to override the basic behavior; * optionally, add a\n`+setup.sh+` script to run manual modification to the image at build\ntime.\n\n== Contributing\n\nSee xref:CONTRIBUTING.adoc[CONTRIBUTING] guide.\n\n== License\n\nSee the LICENSE notice.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrento-project%2Fchecks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrento-project%2Fchecks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrento-project%2Fchecks/lists"}