Merge branch 'master' into 1.7-dev

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

tools/src/test/proto/buf_breaking-version.yaml

@@ -3,4 +3,13 @@
 version: v2
 breaking:  # https://buf.build/docs/configuration/v2/buf-yaml#breaking
   use:  # see https://buf.build/docs/breaking/overview#rules-and-categories
-    - WIRE
+    - WIRE
+  ignore_only:
+    # possible breaks are acknowledged for this specific findings only
+    FIELD_WIRE_COMPATIBLE_CARDINALITY:
+      # DO NOT ADD NEW VERSIONS HERE WITHOUT CONSULTING THE CDX CORE-WORKING-GROUP
+      - 'schema/bom-1.6.proto'
+      - 'schema/bom-1.5.proto'
+    FIELD_WIRE_COMPATIBLE_TYPE:
+      # DO NOT ADD NEW VERSIONS HERE WITHOUT CONSULTING THE CDX CORE-WORKING-GROUP
+      - 'schema/bom-1.5.proto'

tools/src/test/proto/test.sh

@@ -10,27 +10,32 @@ TEST_RES_DIR='tools/src/test/resources'
 
 REMOTE="https://github.com/${GITHUB_REPOSITORY:-CycloneDX/specification}.git"
 
-BUF_IMAGE_VERSION='1.46.0'
+BUF_IMAGE_VERSION='1.50.0'
+BUF_IMAGE="bufbuild/buf:$BUF_IMAGE_VERSION"
+
+LOG_FORMAT='text'  # set to 'json' to see details
+if [[ -n "${GITHUB_WORKFLOW:-}" ]]
+then
+  LOG_FORMAT='github-actions'
+fi
 
 
 ## ----
 
 
+function prepare () {
+  docker pull "$BUF_IMAGE"
+}
+
+
 function schema-lint () {
   echo '> lint schema files' >&2
 
-  if [[ -n "${GITHUB_WORKFLOW:-}" ]]
-  then
-    LOG_FORMAT='github-actions'
-  else
-    LOG_FORMAT='text'
-  fi
-
   docker run --rm \
     --volume "${ROOT_PATH}/${SCHEMA_DIR}:/workspace/${SCHEMA_DIR}:ro" \
     --volume "${THIS_PATH}/buf_lint.yaml:/workspace/buf.yaml:ro" \
     --workdir '/workspace' \
-    bufbuild/buf:"$BUF_IMAGE_VERSION" \
+    "$BUF_IMAGE" \
       lint --path "$SCHEMA_DIR" \
       --error-format "$LOG_FORMAT"
 
@@ -41,17 +46,11 @@ function schema-lint () {
 function schema-breaking-version () {
   echo '> test schema for breaking changes against previous version' >&2
 
-  if [[ -n "${GITHUB_WORKFLOW:-}" ]]
-  then
-    LOG_FORMAT='github-actions'
-  else
-    LOG_FORMAT='text'
-  fi
-
   function compare() {
-    NEW="bom-${1}.proto"
-    OLD="bom-${2}.proto"
+    local NEW="bom-${1}.proto"
+    local OLD="bom-${2}.proto"
 
+    local NEW_NP OLD_NP
     NEW_NP="$(mktemp)"
     OLD_NP="$(mktemp)"
 
@@ -66,15 +65,15 @@ function schema-breaking-version () {
       --volume "${NEW_NP}:/workspaces/new/${SCHEMA_DIR}/${NEW}:ro" \
       --volume "${THIS_PATH}/buf_breaking-version.yaml:/workspaces/new/buf.yaml:ro" \
       --workdir '/workspaces/new' \
-      bufbuild/buf:"$BUF_IMAGE_VERSION" \
+      "$BUF_IMAGE" \
         breaking \
         --against ../old \
         --error-format "$LOG_FORMAT"
   }
 
   compare '1.7' '1.6'
-  # compare '1.6' '1.5'  #  <-- possible breaks are acknowledged
-  # compare '1.5' '1.4'  #  <-- possible breaks are acknowledged
+  compare '1.6' '1.5' || echo "possible breaks are acknowledged for this specific version only"
+  compare '1.5' '1.4' || echo "possible breaks are acknowledged for this specific version only"
   compare '1.4' '1.3'
 
   echo '>> OK.' >&2
@@ -83,18 +82,11 @@ function schema-breaking-version () {
 function schema-breaking-remote () {
   echo '> test schema for breaking changes against remote' >&2
 
-  if [[ -n "${GITHUB_WORKFLOW:-}" ]]
-  then
-    LOG_FORMAT='github-actions'
-  else
-    LOG_FORMAT='text'
-  fi
-
   docker run --rm \
     --volume "${ROOT_PATH}/${SCHEMA_DIR}:/workspace/${SCHEMA_DIR}:ro" \
     --volume "${THIS_PATH}/buf_breaking-remote.yaml:/workspace/buf.yaml:ro" \
     --workdir '/workspace' \
-    bufbuild/buf:"$BUF_IMAGE_VERSION" \
+    "$BUF_IMAGE" \
       breaking --path "$SCHEMA_DIR" \
       --against "${REMOTE}" \
       --error-format "$LOG_FORMAT"
@@ -106,10 +98,10 @@ function schema-functional () {
   echo '> test all examples against the respective schema' >&2
 
   function validate() {
-    FILE="$1"
-    SCHEMA_VERS="$2"
-    SCHEMA_FILE="bom-${SCHEMA_VERS}.proto"
-    MESSAGE="cyclonedx.v${SCHEMA_VERS/./_}.Bom"
+    local FILE="$1"
+    local SCHEMA_VERS="$2"
+    local SCHEMA_FILE="bom-${SCHEMA_VERS}.proto"
+    local MESSAGE="cyclonedx.v${SCHEMA_VERS/./_}.Bom"
 
     echo ">> validate $(realpath --relative-to="$PWD" "$FILE") as ${MESSAGE} of ${SCHEMA_FILE}" >&2
 
@@ -119,13 +111,14 @@ function schema-functional () {
       --volume "${ROOT_PATH}/${SCHEMA_DIR}:/workspace/${SCHEMA_DIR}:ro" \
       --volume "${FILE}:/workspace/test_res:ro" \
       --workdir '/workspace' \
-      bufbuild/buf:"$BUF_IMAGE_VERSION" \
+      "$BUF_IMAGE" \
         convert "${SCHEMA_DIR}/${SCHEMA_FILE}" \
         --type "$MESSAGE" \
         --from 'test_res#format=txtpb' \
         --to /dev/null
   }
 
+  local SCHEMA_VERS
   shopt -s globstar
   for test_res in "$ROOT_PATH"/"$TEST_RES_DIR"/*/valid-*.textproto
   do
@@ -142,23 +135,29 @@ function schema-functional () {
 
 case "${1:-all}" in
   'schema-lint')
+    prepare
     schema-lint
     ;;
   'schema-breaking-version')
+    prepare
     schema-breaking-version
     ;;
   'schema-breaking-remote')
+    prepare
     schema-breaking-remote
     ;;
   'schema-breaking')
+    prepare
     schema-breaking-version
     schema-breaking-remote
     ;;
   'schema-functional')
+    prepare
     schema-functional
     ;;
   'all')
     # all the above
+    prepare
     schema-lint
     schema-breaking-version
     schema-breaking-remote