{"id":17754740,"url":"https://github.com/gianlucam76/ginkgo-tracker-notifier","last_synced_at":"2026-04-13T18:03:39.509Z","repository":{"id":41332130,"uuid":"509073915","full_name":"gianlucam76/ginkgo-tracker-notifier","owner":"gianlucam76","description":"This repo provides integrates ginkgo with jira/elasticsearch/webex/slack","archived":false,"fork":false,"pushed_at":"2023-01-18T20:41:37.000Z","size":116,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-19T23:14:09.755Z","etag":null,"topics":["elasticsearch","ginkgo","gomega","jira","slack","webex"],"latest_commit_sha":null,"homepage":"","language":"Go","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/gianlucam76.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-30T12:37:02.000Z","updated_at":"2023-03-11T19:03:51.000Z","dependencies_parsed_at":"2023-02-10T17:45:47.759Z","dependency_job_id":null,"html_url":"https://github.com/gianlucam76/ginkgo-tracker-notifier","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gianlucam76%2Fginkgo-tracker-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gianlucam76%2Fginkgo-tracker-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gianlucam76%2Fginkgo-tracker-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gianlucam76%2Fginkgo-tracker-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gianlucam76","download_url":"https://codeload.github.com/gianlucam76/ginkgo-tracker-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246628421,"owners_count":20808106,"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":["elasticsearch","ginkgo","gomega","jira","slack","webex"],"created_at":"2024-10-26T14:08:19.729Z","updated_at":"2026-04-13T18:03:34.489Z","avatar_url":"https://github.com/gianlucam76.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"If you are using [Ginkgo](https://onsi.github.io/ginkgo), this package can be of help.\n\nThis package, registered from a ginkgo test suite, provides support for:\n1. Store test-suite results to an elastic DB;\n2. Send notification for failed tests in a test-suite to a webex channel/slack channel;\n3. File Jira issue for each failed tests in a test-suite.\n\nYou can pick what you need (all or a just a subset of supported features).\n\n## Installing\n\n### *go get*\n\n    $ go get -u gianlucam76/ginkgo-tracker-notifier\n\n## Example\n\n```\nimport (\n \tginkgo_helper \"github.com/gianlucam76/ginkgo-tracker-notifier/process_result\"\n )\n```\n\n```\nfunc TestLib(t *testing.T) {\n\tRegisterFailHandler(Fail)\n\n\tsuiteConfig, reporterConfig := GinkgoConfiguration()\n\n \twebexInfo := ginkgo_helper.WebexInfo{\n\t\tAuthToken: \"YOUR WEBEX AUTH TOKEN\",\n\t\tRoom:      \"YOUR WEBEX ROOM\",\n\t}\n\n\tslackInfo := ginkgo_helper.SlackInfo{\n\t\tAuthToken: \"YOUR SLACK AUTH TOKEN\",\n\t\tChannel:   \"YOUR SLACK CHANNEL\",\n\t}\n  \n \telasticInfo := ginkgo_helper.ElasticInfo{\n\t\tURL:        \"YOUR ELASTIC URL\",\n\t\tIndex:      \"YOUR ELASTIC INDEX\",\n\t}\n  \n        defer GinkgoRecover()\n\n\tExpect(ginkgo_helper.Register(context.TODO(),\n\t\tginkgo_helper.WithRunID(12345),         \n\t\tginkgo_helper.WithElastic(elasticInfo),\n\t\tginkgo_helper.WithWebex(webexInfo),\n\t\tginkgo_helper.WithSlack(slackInfo),\n\t)).To(Succeed())\n\n\n\tRunSpecs(t, \"Controllers Suite\", suiteConfig, reporterConfig)\n}\n```\n\n## Installing\n\n### dry run\n\nIf you want to test info provided are correct, you can invoke ginkgo_helper.Register and set dryRun to true (use WithDryRun setter)\nThis will:\n- log what results it would store into the (if provided) elastic DB without actually storing anything;\n- log which message it would send to the (if provided) webex room without actually sending any message;\n- log which message it would send to the (if provided) slack channel without actually sending any message;\n- log which issues it would file to the (if provided) Jira project/board without actually filing any bug.\n\n### make ut\n\nAnother option is to:\n\n1. prepare a config file containing the necessary info. Here is an example\n```\njira:\n    JIRA_BASE_URL: \"your jira base url\"\n    JIRA_PROJECT: \"your jira project\"\n    JIRA_BOARD: \"your jira board\"\n    JIRA_USERNAME: \"your jira username\"\n    JIRA_PASSWORD: \"your jira password\"\n\nwebex:\n    WEBEX_AUTH_TOKEN: \"your webex auth token\"\n    WEBEX_ROOM: \"your webex room\"\n\nslack:\n    SLACK_AUTH_TOKEN: \"your slack token\"\n    SLACK_CHANNEL: \"your slack channel name\"\n\nelastic:\n    ELASTIC_URL: \"your elastic URL\"\n    ELASTIC_INDEX: \"your elastic index\"\n~                             \n```\n2. export TEST_CONFIG_FILE=\u003cfile created at step #1 path\u003e\n3. export FOCUS=WEBEX,JIRA,SLACK,ELASTIC (select a subset if you are testing subset)\n4. make ut\n\nThis will verify provided info are correct (no jira bug will be filed, no message will be sent to webex/slack, no result will be stored to elastic DB).\n\nAll variables set in the file will be exported as env variable.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgianlucam76%2Fginkgo-tracker-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgianlucam76%2Fginkgo-tracker-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgianlucam76%2Fginkgo-tracker-notifier/lists"}