Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update policy data references and policy url checks #32

Merged
merged 3 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ _default: all
DATA_JSON=src/data.json

POLICY_TEMPLATE=src/policy.yaml.tmpl
POLICY_RHTAP_TEMPLATE='src/policy-rhtap.yaml.tmpl'
POLICY_GITHUB_TEMPLATE='src/policy-github.yaml.tmpl'
POLICY_RHTAP_TEMPLATE=src/policy-rhtap.yaml.tmpl
POLICY_GITHUB_TEMPLATE=src/policy-github.yaml.tmpl

ifndef GOMPLATE
GOMPLATE=gomplate
endif

%/policy.yaml: $(POLICY_TEMPLATE) $(DATA_JSON) Makefile
%/policy.yaml: $(POLICY_TEMPLATE) $(DATA_JSON) $(POLICY_RHTAP_TEMPLATE) $(POLICY_GITHUB_TEMPLATE) Makefile
@mkdir -p $(*)
@env NAME=$(*) $(GOMPLATE) -d data=$(DATA_JSON) --file $< \
-t rhtap=$(POLICY_RHTAP_TEMPLATE) -t github=$(POLICY_GITHUB_TEMPLATE) \
Expand All @@ -25,7 +25,7 @@ README_RHTAP_TEMPLATE=src/README-rhtap.md.tmpl
README_GITHUB_TEMPLATE=src/README-github.md.tmpl
README_FILE=README.md

$(README_FILE): $(README_TEMPLATE) $(DATA_JSON) Makefile
$(README_FILE): $(README_TEMPLATE) $(DATA_JSON) $(README_RHTAP_TEMPLATE) $(README_GITHUB_TEMPLATE) Makefile
@$(GOMPLATE) -d data=$(DATA_JSON) --file $< \
-t rhtap=$(README_RHTAP_TEMPLATE) -t github=$(README_GITHUB_TEMPLATE) \
> $@
Expand Down
3 changes: 2 additions & 1 deletion default/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down
3 changes: 2 additions & 1 deletion everything/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down
3 changes: 1 addition & 2 deletions github-default/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ sources:
policy:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
data: []

configuration:
include:
Expand Down
76 changes: 76 additions & 0 deletions hack/verify-policy-sources.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
#!/usr/bin/env bash
# Copyright The Enterprise Contract Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

# Verify the policy source URLs are valid.
# Usage:
# verify-policy-sources.sh

set -o errexit
set -o pipefail
set -o nounset

ERRORS=false

verify_url() {
url=$1
inspect_type=$2
echo -e "\n🕵️‍♀️ $url..."

set +e
info="$(ec inspect "${inspect_type}" --source "${url}" --output=json)"
inspect_status=$?
set -e
if [[ $inspect_status -ne 0 ]]; then
echo '❌ Unable to inspect policy URL'
ERRORS=true
return
else
echo '✅ Policy URL inspection successful'
fi

set +e
echo "${info}" | jq '.' > /dev/null
jq_status=$?
set -e
if [[ $jq_status -ne 0 ]]; then
echo '❌ Data from URL is not valid JSON'
ERRORS=true
return
else
echo '✅ Data from URL is valid JSON'
fi
}

policy_configs="$(< src/data.json yq '.[].name + "/policy.yaml"' -r)"

policy_urls="$(yq eval '.sources[].policy[]' $policy_configs | grep -v -- '---' | sort -u)"
for url in $policy_urls; do
verify_url "${url}" 'policy'
done

policy_data="$(yq eval '.sources[].data[]' $policy_configs | grep -v -- '---' | sort -u)"
for url in $policy_data; do
verify_url "${url}" 'policy-data'
done

echo
if [ $ERRORS = true ]; then
echo '😭 Errors were found'
exit 1
fi

echo '😺 Success!'
3 changes: 2 additions & 1 deletion minimal/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down
3 changes: 2 additions & 1 deletion redhat/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down
3 changes: 2 additions & 1 deletion slsa1/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down
3 changes: 2 additions & 1 deletion slsa2/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down
3 changes: 2 additions & 1 deletion slsa3/policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down
3 changes: 1 addition & 2 deletions src/policy-github.yaml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ sources:
policy:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
data: []

configuration:
include:
Expand Down
3 changes: 2 additions & 1 deletion src/policy-rhtap.yaml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ sources:
- github.com/enterprise-contract/ec-policies//policy/lib
- github.com/enterprise-contract/ec-policies//policy/release
data:
- github.com/enterprise-contract/ec-policies//data
- oci::quay.io/redhat-appstudio-tekton-catalog/data-acceptable-bundles:latest
- github.com/release-engineering/rhtap-ec-policy//data

configuration:
include:
Expand Down