{"id":15713624,"url":"https://github.com/cnti-testcatalog/testsuite","last_synced_at":"2025-03-03T14:05:18.066Z","repository":{"id":37253896,"uuid":"234632572","full_name":"cnti-testcatalog/testsuite","owner":"cnti-testcatalog","description":"📞📱☎️📡🌐 Cloud Native Telecom Initiative (CNTI) Test Catalog is a tool to check for and provide feedback on the use of K8s + cloud native best practices in networking applications and platforms","archived":false,"fork":false,"pushed_at":"2025-02-10T09:56:48.000Z","size":33448,"stargazers_count":178,"open_issues_count":99,"forks_count":72,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-02-15T19:52:32.701Z","etag":null,"topics":["best-practices","cloud-native","cnf","cnfs","conformance-tests","crystal","good-first-issue","k8s","kubernetes"],"latest_commit_sha":null,"homepage":"https://wiki.lfnetworking.org/display/LN/Test+Catalog","language":"Mustache","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cnti-testcatalog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-17T20:42:03.000Z","updated_at":"2025-02-05T15:20:40.000Z","dependencies_parsed_at":"2023-12-29T23:21:22.681Z","dependency_job_id":"c4141d49-cdc4-4ee5-8582-47835ea7e4e5","html_url":"https://github.com/cnti-testcatalog/testsuite","commit_stats":{"total_commits":4646,"total_committers":61,"mean_commits":76.1639344262295,"dds":0.6360309944037882,"last_synced_commit":"531e9a1c4b679b110791ce83d2162a3cffb66e6b"},"previous_names":[],"tags_count":636,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnti-testcatalog%2Ftestsuite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnti-testcatalog%2Ftestsuite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnti-testcatalog%2Ftestsuite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnti-testcatalog%2Ftestsuite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cnti-testcatalog","download_url":"https://codeload.github.com/cnti-testcatalog/testsuite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240483756,"owners_count":19808634,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["best-practices","cloud-native","cnf","cnfs","conformance-tests","crystal","good-first-issue","k8s","kubernetes"],"created_at":"2024-10-03T21:32:32.268Z","updated_at":"2025-02-24T13:07:25.173Z","avatar_url":"https://github.com/cnti-testcatalog.png","language":"Mustache","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CNTi Test Catalog\n\n| Main                                                                                                                                        |\n| ------------------------------------------------------------------------------------------------------------------------------------------- |\n| [![Build Status](https://github.com/cnti-testcatalog/testsuite/workflows/Crystal%20Specs/badge.svg)](https://github.com/cnti-testcatalog/testsuite/actions) |\n\nThe CNTi Test Catalog is an open source and vendor neutral tool that can be used to validate a telco application's adherence to [cloud native principles](https://networking.cloud-native-principles.org/) and best practices. \n\nThis Test Catalog focus area is one part of LF Networking's [Cloud Native Telecom Initiative (CNTi)](https://wiki.lfnetworking.org/pages/viewpage.action?pageId=113213592) and works closely with the [CNTi Best Practices](https://wiki.lfnetworking.org/display/LN/Best+Practices) and [CNTi Certification](https://wiki.lfnetworking.org/display/LN/Certification) focus areas.\n\n## Installation and Usage\n\nTo get the CNTi Test Catalog up and running, see the [Installation Guide](INSTALL.md).\n\n#### To give it a try immediately you can use these quick install steps\n\nPrereqs: Kubernetes cluster, wget, curl, helm 3.1.1 or greater on your system already.\n\n1. Install the latest test suite binary: `source \u003c(curl -s https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/curl_install.sh)`\n2. Run `setup` to prepare the cnf-testsuite: `cnf-testsuite setup`\n3. Pull down an example CNF configuration to try: `curl -o cnf-testsuite.yml https://raw.githubusercontent.com/cnti-testcatalog/testsuite/main/example-cnfs/coredns/cnf-testsuite.yml`\n4. Initialize the test suite for using the CNF: `cnf-testsuite cnf_install cnf-config=./cnf-testsuite.yml`\n5. Run all of application/workload tests: `cnf-testsuite workload`\n\n#### More Usage docs\n\nCheck out the [usage documentation](USAGE.md) for more info about invoking commands and logging.\n\n## Cloud Native Test Categories\n\nThe CNTi Test Catalog will inspect CNFs for the following characteristics:\n\n- **Configuration** - The CNF's configuration should be managed in a declarative manner, using ConfigMaps, Operators, or other declarative interfaces.\n- **Compatibility, Installability \u0026 Upgradability** - CNFs should work with any Certified Kubernetes product and any CNI-compatible network that meet their functionality requirements while using standard, in-band deployment tools such as Helm (version 3) charts.\n- **Microservice** - The CNF should be developed and delivered as a microservice.\n- **State** - The CNF's state should be stored in a custom resource definition or a separate database (e.g. etcd) rather than requiring local storage. The CNF should also be resilient to node failure.\n- **Reliability, Resilience \u0026 Availability** - CNFs should be reliable, resilient and available to failures inevitable in cloud environments. CNFs should be tested to ensure they are designed to deal with non-carrier-grade shared cloud HW/SW platforms.\n- **Observability \u0026 Diagnostics** - CNFs should externalize their internal states in a way that supports metrics, tracing, and logging.\n- **Security** - CNF containers should be isolated from one another and the host. CNFs are to be verified against any common CVE or other vulnerabilities.\n\nSee the [Test Documentation](docs/TEST_DOCUMENTATION.md) for a complete overview of the tests.\n\n## Contributing\n\nWelcome! We gladly accept contributions on new tests, example CNFs, updates to documentation, enhancements, bug reports, and more.\n\n- [Contributing guide](CONTRIBUTING.md)\n- [Good first issues](https://github.com/cnti-testcatalog/testsuite/labels/good%20first%20issue)\n- [Contributions welcome](https://github.com/cnti-testcatalog/testsuite/labels/contributions-welcome)\n\n## Communication and Community Meetings\n\n- Join the conversation on [LFN Tech's Slack](https://lfntech.slack.com/) channel [#cnti](https://lfntech.slack.com/archives/C06HQGWK4NL)\n- Join the weekly CNTi Test Catalog meeting\n  - [Meeting details](https://lf-networking.atlassian.net/wiki/spaces/CNTi/pages/130416641/Cloud+Native+Telecom+Initiative+CNTi#Test-Catalog) \n  - [Meeting minutes](https://docs.google.com/document/d/1yjL079TR0L1q__BRuhREeXfx5MtAmjPzbFZlZUeBsK4/edit)\n\n\n## Code of Conduct\n\nThe CNTi community follows the [LF's Code of Conduct](https://lfprojects.org/policies/code-of-conduct/).\n\n## License Terms\n\nThe CNTi Test Catalog is available under the [Apache 2 license](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnti-testcatalog%2Ftestsuite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcnti-testcatalog%2Ftestsuite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnti-testcatalog%2Ftestsuite/lists"}