/insights-sha-extractor

Service based on Insights Core Messaging to extract SHA of images send by Insights Operator

Primary LanguageShellApache License 2.0Apache-2.0

Insights SHA Extractor

Python 3.7 GitHub Pages License GitHub release

Description

Insights SHA Extractor service intends to retrieve Insights gathered archives and export SHAs of images found in the archive. SHAs of images are published back in order to be consumed by other services. Insights SHA Extractor is based on Insights Core Messaging framework.

Documentation

Documentation is hosted on Github Pages https://supreme-garbanzo-c43cccab.pages.github.io/.

Makefile targets

Usage: make <OPTIONS> ... <TARGETS>

Available targets are:

unit_tests           Run unit tests
coverage             Run unit tests, display code coverage on terminal
coverage-report      Run unit tests, generate code coverage as a HTML report
documentation        Generate documentation for all sources
shellcheck           Run shellcheck
pycodestyle          Check code style of all Python sources
pydocstyle           Check docstrings style of all Python sources
pyformat-check       Check formatting of all Python sources
pyformat             Reformat all Python sources
help                 Show this help screen

BDD tests

Behaviour tests for this service are included in Insights Behavioral Spec repository. In order to run these tests, the following steps need to be made:

  1. clone the Insights Behavioral Spec repository
  2. go into the cloned subdirectory insights-behavioral-spec
  3. run the aggregator_tests.sh from this subdirectory

List of all test scenarios prepared for this service is available at https://redhatinsights.github.io/insights-behavioral-spec/feature_list.html#sha-extractor

Package manifest

Package manifest is available at docs/manifest.txt.