{"id":26002748,"url":"https://github.com/1and1/httpselftest","last_synced_at":"2026-06-01T03:31:46.556Z","repository":{"id":57737522,"uuid":"169548951","full_name":"1and1/httpselftest","owner":"1and1","description":"Utility servlet for HTTP health tests","archived":false,"fork":false,"pushed_at":"2022-05-05T20:24:59.000Z","size":321,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-13T18:08:29.532Z","etag":null,"topics":["debugging-tools","java","smoke-test"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/1and1.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-07T09:43:37.000Z","updated_at":"2022-01-15T10:21:39.000Z","dependencies_parsed_at":"2022-08-24T14:59:42.260Z","dependency_job_id":null,"html_url":"https://github.com/1and1/httpselftest","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/1and1/httpselftest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fhttpselftest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fhttpselftest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fhttpselftest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fhttpselftest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1and1","download_url":"https://codeload.github.com/1and1/httpselftest/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1and1%2Fhttpselftest/sbom","scorecard":{"id":2009,"data":{"date":"2025-08-11","repo":{"name":"github.com/1and1/httpselftest","commit":"8f7e335d96b88a50bae6e02c7339991619495745"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T12:46:48.070Z","repository_id":57737522,"created_at":"2025-08-14T12:46:48.070Z","updated_at":"2025-08-14T12:46:48.070Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33759178,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["debugging-tools","java","smoke-test"],"created_at":"2025-03-05T19:30:12.127Z","updated_at":"2026-06-01T03:31:46.542Z","avatar_url":"https://github.com/1and1.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HTTP Selftest\n[![Build Status](https://travis-ci.org/1and1/httpselftest.svg?branch=master)](https://travis-ci.org/1and1/httpselftest)\n[![Latest release](https://img.shields.io/github/release/1and1/httpselftest.svg)](https://github.com/1and1/httpselftest/releases/latest)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.oneandone.httpselftest/selftest-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.oneandone.httpselftest/selftest-core)\n\nThis repo implements a base servlet and surrounding infrastructure to enable semi-automatic tests against a running application in any development stage. The tests are deployed with the application and run against itself. Test parameters can be pre-defined or provided by the user. This allows to have meaningful test parameters across multiple stages and environments.\n\nThe intended use is not clear-cut. The servlet can be used for e.g.\n- basic integration tests,\n- smoke tests before general release,\n- incident response,\n- definitive insight into interface behavior.\n\n## Usage example\n### Test run summary\n![Single test output](doc/clip_run_collapsed.png)\n\n### Single test output including request, response and log messages\n![Single test output](doc/clip_single_test.png)\n\n### Test case implementation example\n```java\npublic class MinimalSelftestServlet extends SelftestServlet {\n    @Override\n    protected TestConfigs getConfigs() {\n        return new TestConfigs(\"param1\");\n    }\n    public static class TestEcho implements TestCase {\n        @Override\n        public TestRequest prepareRequest(TestValues config, Context ctx) throws Exception {\n            return new TestRequest(\"echo\", \"GET\");\n        }\n        @Override\n        public void verify(TestValues config, TestResponse response, Context ctx) throws Exception {\n            Assertions.assertEqual(\"status code\", 200, response.getStatus());\n        }\n    }\n}\n```\n\n### Interactive example\nYou can easily play around with a simple test suite. Just launch the example app in the `spring-boot-example` module.\n\n```bash\ngit clone https://github.com/1and1/httpselftest.git\ncd httpselftest/selftest-springboot-example/\nmvn spring-boot:run\n# point your browser to the actuator endpoint: http://localhost:8081/actuator/selftest\n# OR to the application port http://localhost:8080/selftest\n```\n\n## Integration\n### GAV\n```xml\n\u003cdependency\u003e\n   \u003cgroupId\u003enet.oneandone.httpselftest\u003c/groupId\u003e\n   \u003cartifactId\u003eselftest-core\u003c/artifactId\u003e\n   \u003cversion\u003e$VERSION\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Dependencies\n- Since HTTP Selftest is implemented as a Servlet, there is an implicit dependency on the javax Servlet API.\n- HTML rendering is done using [j2html](https://j2html.com/). The dependency is co-packaged and shaded to avoid conflicts with production dependencies.\n- JSON handling is done using [json-simple](https://cliftonlabs.github.io/json-simple/). The dependency is co-packaged and shaded to avoid conflicts with production dependencies.\n- In case [Logback](https://logback.qos.ch/) logging support is used, logback dependencies need to be on the classpath (`logback-classic` and `logback-core`).\n\n### Security\nThe servlet is not supposed to be exposed to the internet. This is an internal developer tool. Additionally, you may want to set `selftest.credentials`.\n\n### Usage as Spring Boot 2 Actuator\nIf your application is a Spring Boot 2 app, the servlet can be registered as a `@ServletEndpoint`. In this case the application port and base path may need to be provided manually. The servlet will be running on the management port.\n\n```java\n@ServletEndpoint(id = \"selftest\")\npublic class SelftestEndpoint implements Supplier\u003cEndpointServlet\u003e {\n\n    @Override\n    public EndpointServlet get() {\n        return new EndpointServlet(YourSelftestServlet.class)\n            .withInitParameter(SelftestServlet.PROP_OVERRIDE_PORT, \"8080\")\n            .withInitParameter(SelftestServlet.PROP_OVERRIDE_PATH, \"/rest\");\n    }\n\n}\n```\n### Usage as Spring Boot raw servlet\nIf your application is a Spring Boot app, the servlet can be registered by the way of `ServletRegistrationBean`. This way it will be running on the application port.\n\n```java\n@Bean\npublic ServletRegistrationBean\u003cYourSelftestServlet\u003e onProductionPort() {\n    return new ServletRegistrationBean\u003c\u003e(new YourSelftestServlet(), \"/selftest\");\n}\n```\n\n### Usage otherwise\nIf your application has a `web.xml`, the servlet containing your test cases can be registered there.\n```xml\n\u003cservlet\u003e\n   \u003cservlet-name\u003eSelfTestServlet\u003c/servlet-name\u003e\n   \u003cservlet-class\u003e${SUBCLASS_OF_SelftestServlet}\u003c/servlet-class\u003e\n\u003c/servlet\u003e\n\u003cservlet-mapping\u003e\n   \u003cservlet-name\u003eSelfTestServlet\u003c/servlet-name\u003e\n   \u003curl-pattern\u003e/selftest\u003c/url-pattern\u003e\n\u003c/servlet-mapping\u003e\n```\n\n### Collecting request tracking IDs\nIf you want to collect log messages and your application is not already collecting request tracking IDs in the MDC, you can do so by registering a `SelftestMDCFilter`.\n\nThe filter can be registered in Spring Boot apps by the way of `FilterRegistrationBean`.\n\n```java\n@Bean\npublic FilterRegistrationBean selftestFilter() {\n    FilterRegistrationBean filter = new FilterRegistrationBean();\n    filter.setFilter(new SelftestMDCFilter());\n    filter.addUrlPatterns(\"/*\");\n    filter.setName(\"selftestFilter\");\n    filter.setOrder(Ordered.HIGHEST_PRECEDENCE);\n    return filter;\n}\n```\n\nIf you have a `web.xml` you can register it there.\n```xml\n\u003cfilter\u003e\n   \u003cfilter-name\u003eSelftestMDCFilter\u003c/filter-name\u003e\n   \u003cfilter-class\u003enet.oneandone.httpselftest.servlet.SelftestMDCFilter\u003c/filter-class\u003e\n\u003c/filter\u003e\n\u003cfilter-mapping\u003e\n   \u003cfilter-name\u003eSelftestMDCFilter\u003c/filter-name\u003e\n   \u003curl-pattern\u003e/*\u003c/url-pattern\u003e\n\u003c/filter-mapping\u003e\n```\n\n## Configuration\n|  Servlet init parameter | Description | Default value |\n|---|---| --- |\n| `selftest.credentials` | Credentials for HTTP Basic authentication. Supports plain or SHA-256 (prefix with `plain\\|` or `sha256\\|`). | no authentication |\n| `selftest.logger` | Logging framework to be used for log message extraction. Possible values: `[none, logback]` | `logback` |\n| `selftest.configgroups` | Config groups can be used to filter out pre-defined configs that are irrelevant to the current environment. The values will be matched against the current hostname. Example: `\"local, staging\"`. Check the example application for usage. | no groups |\n| `selftest.override.port` | Override for application port. Necessary if the httpselftest servlet runs on another port. | application port |\n| `selftest.override.contextpath` | Override for application context path. Necessary if the httpselftest servlet runs on another port. | application path |\n| `selftest.override.mdckey` | Override for MDC key storing the request tracking id. | `X-REQUEST-ID` |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1and1%2Fhttpselftest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1and1%2Fhttpselftest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1and1%2Fhttpselftest/lists"}