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.

Sign up for GitHub

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

Add consistency check for deepcopy generated files #1127

Merged
merged 5 commits into from
Jun 2, 2023
Merged

Add consistency check for deepcopy generated files #1127

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
07656de
Add consistency check for deepcopy generated files
May 30, 2023
279ac32
update deepcopy generated file
May 30, 2023
0e2de3d
revert linter changes
Jun 1, 2023
4b1bdd5
ignore zz_generated.deepcopy.go file from goimports
Jun 2, 2023
9185a3a
add comment in testjob.yaml and nit cleanup
Jun 2, 2023
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
4 changes: 4 additions & 0 deletions .github/workflows/consistency-check.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ jobs:
- name: Verify Codegen
working-directory: ./ray-operator
run: ./hack/verify-codegen.sh

- name: Verify Generated Files
Copy link
Contributor

@Yicheng-Lu-llll Yicheng-Lu-llll Jun 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a nit-picky comment, we can have a better name here.

-Verify Generated Files: showing it is used to verify the aforementioned runtime.Object interface generated by kubebuilder.

-Verify Codegen: showing it is used to verify things like clientset, lister, informer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got the idea from Kubernetes repo (https://github.com/kubernetes/kubernetes/blob/v1.22.1/hack/verify-generated-files.sh). Please suggest better alternatives.

working-directory: ./ray-operator
run: ./hack/verify-generated-files.sh
# 1. Check consistency between types.go and CRD YAML files.
# 2. Check consistency between kubebuilder markers and RBAC.
ray-operator-verify-crd-rbac:
Expand Down
2 changes: 1 addition & 1 deletion ray-operator/apis/ray/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 35 additions & 0 deletions ray-operator/hack/verify-generated-files.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#!/bin/bash

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

SCRIPT_ROOT=$(dirname "${BASH_SOURCE[0]}")/..

DIFFROOT="${SCRIPT_ROOT}/apis"
TMP_DIFFROOT="${SCRIPT_ROOT}/_tmp/apis"
_tmp="${SCRIPT_ROOT}/_tmp"

cleanup() {
rm -rf "${_tmp}"
}
trap "cleanup" EXIT SIGINT

cleanup

mkdir -p "${TMP_DIFFROOT}"
cp -a "${DIFFROOT}"/* "${TMP_DIFFROOT}"

#"${SCRIPT_ROOT}/hack/update-codegen.sh"
make generate
echo "diffing ${DIFFROOT} against freshly generated deepcopy files"
ret=0
diff -Naupr "${DIFFROOT}" "${TMP_DIFFROOT}" || ret=$?
cp -a "${TMP_DIFFROOT}"/* "${DIFFROOT}"
if [[ $ret -eq 0 ]]
then
echo "${DIFFROOT} up to date."
else
echo "${DIFFROOT} is out of date. Please run make generate"
exit 1
fi