Sanitize Branch Names for Docker Containers

[kj4ezj]

Change Description

From #help-automation and AUTO-848, a developer created an eos branch name with a hash tag # character (e.g. "pr#125"). This broke the Docker - Build and Install step because it requires branch names to be valid URIs, currently only transforming forward-slashes / into underscores _ to support branch names with forward-slashes.

This pull request adds a series of transforms to turn forward-slashes / into underscores _, turn all other invalid characters for a docker container name into dashes -, then minimize sequences of these replacement characters and ensure they are not the beginning or end of the string.

I have also added log folding groups and improved the patterns in /.cicd/create-docker-from-binary.sh, and updated the pipeline readme.

See Also

• eos
  • Pull Request 10366 -- Closed
  • Pull Request 10372 -- eos:develop
  • Pull Request 10373 -- eos:release/2.1.x
  • Pull Request 10374 -- eos:release/2.0.x
• auto-events-subscribers
  • Pull Request 458 -- buildkiteJobMetrics.js: Sanitize Branch Names + Test Cleanup

Change Type

Select ONE:

• Documentation
• Stability bug fix
• Other
• Other - special case

Testing Changes

Select ANY that apply:

• New Tests
• Existing Tests
• Test Framework
• CI System
• Other

Consensus Changes

• Consensus Changes

None.

API Changes

• API Changes

None.

Documentation Additions

• Documentation Additions

None.

[kj4ezj]

Closed in favor of pull request 10372 because buildkite-agent is trying to perform interpolation on the branch name in the pipeline.yml here:

  - label: ":chains: Sync from Genesis Test"
    trigger: "eosio-sync-from-genesis"
    async: false
    if: build.env("BUILDKITE_TAG") == null
    build:
      message: "Triggered by eosio build 28443"
      commit: "53323023b0707fdd5bd26947781b92251af77f95"
      branch: "zach-_=+#/@&$#Ω"
      env:
        BUILDKITE_TRIGGERED_FROM_BUILD_URL: "https://buildkite.com/EOSIO/eosio/builds/28443"
        SKIP_JUNGLE: "true"
        SKIP_KYLIN: ""
        SKIP_MAIN: ""
        TIMEOUT: ""

  - label: ":outbox_tray: Resume from State Test"
    trigger: "eosio-resume-from-state"
    async: false
    if: build.env("BUILDKITE_TAG") == null
    build:
      message: "Triggered by eosio build 28443"
      commit: "53323023b0707fdd5bd26947781b92251af77f95"
      branch: "zach-_=+#/@&$#Ω"
      env:
        BUILDKITE_TRIGGERED_FROM_BUILD_URL: "https://buildkite.com/EOSIO/eosio/builds/28443"
        SKIP_JUNGLE: "true"
        SKIP_KYLIN: ""
        SKIP_MAIN: ""
        TIMEOUT: ""

  - wait:
    continue_on_failure: true

This is, in my opinion, a bug on Buildkite's end because valid branch names can apparently contain a $ character followed by other characters that could look like an identifier. I don't think buildkite-agent should perform shell interpolation on the git branch or tag strings, where they exist. Buildkite does offer the --no-interpolation flag to mitigate this, but converting this pipeline to use envsubst for interpolation is perhaps a bit more work than I had planned to do for this service item.