https://github.com/redhatinsights/insights-results-smart-proxy
Smart proxy for insights results
https://github.com/redhatinsights/insights-results-smart-proxy
Last synced: about 2 months ago
JSON representation
Smart proxy for insights results
- Host: GitHub
- URL: https://github.com/redhatinsights/insights-results-smart-proxy
- Owner: RedHatInsights
- License: apache-2.0
- Created: 2020-05-26T13:57:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T00:45:12.000Z (2 months ago)
- Last Synced: 2025-04-10T01:24:40.803Z (2 months ago)
- Language: Go
- Size: 28.3 MB
- Stars: 3
- Watchers: 6
- Forks: 20
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# insights-results-smart-proxy
[](https://go.dev/)
[](https://godoc.org/github.com/RedHatInsights/insights-results-smart-proxy)
[](https://redhatinsights.github.io/insights-results-smart-proxy/)
[](https://goreportcard.com/report/github.com/RedHatInsights/insights-results-smart-proxy)
[](https://ci.ext.devshift.net/job/RedHatInsights-insights-results-smart-proxy-gh-build-master/)
[](https://github.com/RedHatInsights/insights-results-smart-proxy/blob/master/LICENSE)
Smart proxy for insights results
* [Description](#description)
* [Documentation](#documentation)
* [BDD tests](#bdd-tests)
* [Makefile targets](#makefile-targets)
* [Contribution](#contribution)
* [Package manifest](#package-manifest)
## Description
Insights Results Smart Proxy is a service that acts as a proxy between the different external
data pipeline clients and the different services providing the required information.
It provides access to the [Insights Results Aggregator](https://github.com/RedHatInsights/insights-results-aggregator)
and to the [Insights Content Service](https://github.com/RedHatInsights/insights-content-service),
providing the clients with different endpoints for accesing both report results and rule content metadata
from a single service.
## Documentation
Documentation is hosted on Github Pages .
Sources are located in [docs](https://github.com/RedHatInsights/insights-results-smart-proxy/tree/master/docs).
## BDD tests
Behaviour tests for this service are included in [Insights Behavioral
Spec](https://github.com/RedHatInsights/insights-behavioral-spec) repository.
In order to run these tests, the following steps need to be made:
1. clone the [Insights Behavioral Spec](https://github.com/RedHatInsights/insights-behavioral-spec) repository
1. go into the cloned subdirectory `insights-behavioral-spec`
1. run the `smart_proxy_tests.sh` from this subdirectory
List of all test scenarios prepared for this service is available at
## Makefile targets
```
Usage: make ...
Available targets are:
clean Run go clean
build Build binary containing service executable
build-cover Build binary with code coverage detection support
fmt Run go fmt -w for all sources
lint Run golint
vet Run go vet. Report likely mistakes in source code
cyclo Run gocyclo
ineffassign Run ineffassign checker
shellcheck Run shellcheck
errcheck Run errcheck
goconst Run goconst checker
gosec Run gosec checker
abcgo Run ABC metrics checker
style Run all the formatting related commands (fmt, vet, lint, cyclo) + check shell scripts
run Build the project and executes the binary
test Run the unit tests
help Show this help screen
```
## Contribution
Please look into document [CONTRIBUTING.md](CONTRIBUTING.md) that contains all information about how to
contribute to this project.
## Package manifest
Package manifest is available at [docs/manifest.txt](docs/manifest.txt).