Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

Commit

Permalink
Merge pull request #244 from dirgim/STONEINTG-765
Browse files Browse the repository at this point in the history 
feat(STONEINTG-765): remove outdated info in surface-tests doc
  • Loading branch information
@gtrivedi88
gtrivedi88 authored Mar 27, 2024
2 parents ec338ce + efe02c2 commit a9a903c
Showing 1 changed file with 5 additions and 61 deletions.
66 changes: 5 additions & 61 deletions .../modules/ROOT/pages/how-to-guides/testing_applications/surface-level_tests.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,74 +5,18 @@
This document covers the surface-level tests (formerly known as "sanity tests") that {ProductName} runs as part of its component build pipeline. These surface-level tests automatically check all application images to ensure that they're up-to-date, correctly formatted, and protected from security vulnerabilities.

== Surface-level tests
The {ProductName} component build pipeline supports several types of tests, including surface-level tests. The surface-level tests used in {ProductName} are run in the form of https://tekton.dev/docs/pipelines/tasks/#overview[Tekton tasks]. The utility used for validating container information is https://www.conftest.dev/[Conftest]. The following tables show the currently implemented surface-level tests:

=== Label checks

.Required label checks
|===
|Test name |Label name |Description |Failure message

|com_redhat_component_label_required |com.redhat.component|Bugzilla component name where bugs against this container should be reported by users |The Required 'com.redhat.component' label is missing!
|name_label_required |name |Name of the image or container |The required 'name' label is missing!
|version_label_required |version |Version of the image |The required 'version' label is missing!
|description_label_required |description |Detailed description of the image |The required 'description' label is missing!
|io_k8s_description_label_required |io.k8s.description |Description of the container in Kubernetes |The required 'io.k8s.description' label is missing!
|vcs_ref_label_required |vcs-ref |A reference within the version control used by the container source. Usually git, hg, svn, bzr, or cvs |The required 'vcs-ref' label is missing!
|architecture_label_required |architecture |Architecture the software in the image should target. Default is Fedora OS |The 'architecture' label is missing!
|vendor_label_required |vendor |Name of the vendor |The required 'vendor' label is missing!
|release_label_required |release |Release number for this version |The 'release' label is missing!
|url_label_required |url |A URL where the user can find more information about the image | The required 'url' label is missing!
|build_date_label_required |build-date |Date/Time image was built as RFC 3339 date-time |The required 'build-date' label is missing!
|distribution_scope_label_required |distribution_scope | Scope of the intended distribution of the image |The required 'distribution-scope' label is missing!

|===

.Deprecated label checks
|===
|Test name |Label name |Description |Failure message

|install_label_deprecated |INSTALL |The 'INSTALL' label is deprecated, replace with 'install' |The INSTALL label is deprecated!
|architecture_label_deprecated |Architecture | The 'Architecture' label is deprecated, replace with 'architecture' |The Architecture label is deprecated!
|bzcomponent_label_deprecated | BZComponent |the BZComponent label is deprecated, prelace with 'com.redhat.component' |The BZComponent label is deprecated!
|name_label_deprecated |Name |The 'Name' label is deprecated, replace with 'name' |The Name label is deprecated!
|release_label_deprecated |Release |The 'Release' label is deprecated, replace with 'release' |The Release label is deprecated!
|uninstall_label_deprecated |UNINSTALL |The 'UNINSTALL' label is deprecated, replace with 'uninstall' |The UNINSTALL label is deprecated!
|version_label_deprecated |Version |The 'Version' label is deprecated, replace with 'version' |The Version label is deprecated!
|run_label_deprecated |RUN |The 'RUN' label is deprecated, replace with 'run' |The RUN label is deprecated!

|===

.Inherited label checks
|===
|Test name |Label name |Description |Failure message

|summary_label_inherited |summary |If the label is inherited from the base image but not specified in the Dockerfile, it will contain an incorrect value for the built image |The 'summary' label should not be inherited from the base image
|description_label_inherited |description |If the label is inherited from the base image but not specified in the Dockerfile, it will contain an incorrect value for the built image |The 'description' label should not be inherited from the base image
|io_description_label_inherited |io.k8s.description |If the label is inherited from the base image but not specified in the Dockerfile, it will contain an incorrect value for the built image |The 'io.k8s.description' label should not be inherited from the base image
|io_k8s_display_name_label_inherited |io.k8s.diplay-name |If the label is inherited from the base image but not specified in the Dockerfile, it will contain an incorrect value for the built image |The 'io.k8s.display-name' label should not be inherited from the base image
|io_openshift_tags_label_inherited |io.openshift.tags |If the label is inherited from the base image but not specified in the Dockerfile, it will contain an incorrect value for the built image |The 'io.openshift.tags' should not be inherited from the base image

|===

.Optional label checks
|===
|Test name |Label name |Description |Failure message

|Maintainer_label_required |maintainer |The name and email of the maintainer. Should contain 'Red Hat' or '@redhat.com' |The 'maintainer' label should be defined
|summary_label_required |summary |A short description of the image |The 'summary' label should be defined
|===
The {ProductName} component build pipeline supports several types of tests, including surface-level tests. The surface-level tests used in {ProductName} are run in the form of https://tekton.dev/docs/pipelines/tasks/#overview[Tekton tasks]. The utility used for validating container information is https://www.conftest.dev/[Conftest]. The following tables show the currently implemented surface-level tests:

.Deprecated image checks
|===
|Test name |Label name |Description |Failure message
|Test name |Description |Failure message

|image_repository_deprecated |N/A |Deprecated images are no longer maintained and will accumulate security issues without releasing a fixed version | The container image should not be built from a repository which is marked as 'Deprecated' in COMET
|image_repository_deprecated |Deprecated images are no longer maintained, leading to unresolved security vulnerabilities. | The container image must not be built from a repository marked as 'Deprecated' in COMET
|===

.Unsigned RPM check
|===
|Test name |Label name |Description |Failure message
|Test name |Description |Failure message

|image_unsigned_rpms |N/A |Providing packages signed with the secure Red Hat signing server indicates that the package was subject to all appropriate policies and procedures |All RPMs found on the image must be signed. Found following unsigned rpms(nvra):
|image_unsigned_rpms |Packages signed with Red Hat's secure signing server adheres to stringent policies and procedures. |All RPMs in the image must be signed. Found following unsigned rpms(nvra):
|===

0 comments on commit a9a903c

Please sign in to comment.