{"id":22096045,"url":"https://github.com/perimeterx/remote-code-cover","last_synced_at":"2025-03-24T00:55:23.771Z","repository":{"id":70060560,"uuid":"174225102","full_name":"PerimeterX/remote-code-cover","owner":"PerimeterX","description":"rcc is a CLI tool for code coverage using instrumentation for remote environments","archived":false,"fork":false,"pushed_at":"2019-03-28T22:07:28.000Z","size":38,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-01-29T07:30:22.328Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/PerimeterX.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-06T21:37:28.000Z","updated_at":"2019-03-29T08:30:52.000Z","dependencies_parsed_at":"2023-04-04T08:01:57.587Z","dependency_job_id":null,"html_url":"https://github.com/PerimeterX/remote-code-cover","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerimeterX%2Fremote-code-cover","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerimeterX%2Fremote-code-cover/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerimeterX%2Fremote-code-cover/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerimeterX%2Fremote-code-cover/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PerimeterX","download_url":"https://codeload.github.com/PerimeterX/remote-code-cover/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245191635,"owners_count":20575248,"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":[],"created_at":"2024-12-01T04:09:31.792Z","updated_at":"2025-03-24T00:55:23.757Z","avatar_url":"https://github.com/PerimeterX.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Remote Code Cover\n\nrcc is a CLI tool for code instrumentation and test coverage reporting, with support for:\n\n- Fastly VCL\n\n## Installation\n\n1. Change to your preferred python setup (preferred from a virtual environment)\n2. Run `pip install git+https://github.com/PerimeterX/remote-code-cover`\n\n\u003e If a permissions error occurs, add --user flag to the command: `pip install --user ...`\n\n## Usage\n\nRun `rcc --help` for usage instructions.\n\n### Fastly VCL\n\nPrerequisites:\n\n1. Docker daemon running on your machine\n2. A Fastly service with custom VCL and credentials for that service\n\nUsing reserved TCP address with Ngrok:\n\n```bash\nrcc fastly --fastly-token \u003cfastly_api_key\u003e \\\n--fastly-service-id \u003cfastly_service_id\u003e \\\n--proxy-remote-addr \u003ctcp_domain\u003e:\u003cport\u003e \\\n--ngrok-auth-token \u003cngrok_premium_token\u003e\n```\n\nOr, using a standalone proxy is running in the background and forwarding TCP to port 514:\n\n```bash\nrcc fastly --fastly-token \u003cfastly_api_key\u003e \\\n--fastly-service-id \u003cfastly_service_id\u003e \\\n--proxy-remote-addr \u003ctcp_domain\u003e:\u003cport\u003e \\\n--standalone-proxy\n```\n\nThe above commands will create a new version for the service with the instrumented code,\nand then wait for tests to be run against the configured website:\n\n```\n! You can now run the tests. Press any key when the tests finished..\n```\n\nAfter clicking, a coverage report will be created at `./coverage` and opened in the browser, which looks like:\n\n![Example Fastly VCL Report](https://github.com/PerimeterX/remote-code-cover/blob/master/assets/example-vcl-report.png)\n\nYou can run `rcc fastly --help` for exact usage info.\n\nThat's it!\n\n## Contributing\n\nThe following steps are welcome when contributing to our project:\n\n### Fork/Clone\nFirst and foremost, [Create a fork](https://guides.github.com/activities/forking/) of the repository, and clone it locally.\nCreate a branch on your fork, preferably using a self descriptive branch name.\n\n### Code/Run\nHelp improve our project by implementing missing features, adding capabilities or fixing bugs.\n\nTo run the code, simply follow the steps in the [installation Section](#installation).\n\n### Pull Request\nAfter you have completed the process, create a pull request to the Upstream repository.\nPlease provide a complete and thorough description explaining the changes.\nRemember this code has to be read by our maintainers, so keep it simple, smart and accurate.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperimeterx%2Fremote-code-cover","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperimeterx%2Fremote-code-cover","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperimeterx%2Fremote-code-cover/lists"}