Skip to content

Ci Workflowtemplate

Note

This example is a replication of an Argo Workflow example in Hera. The upstream example can be found here.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
from hera.workflows import (
    DAG,
    Container,
    NoneArchiveStrategy,
    Parameter,
    S3Artifact,
    Task,
    WorkflowTemplate,
    models as m,
)

with WorkflowTemplate(
    name="ci",
    arguments=[
        Parameter(name="branch", value="master"),
    ],
    entrypoint="main",
    on_exit="cache-store",
    volume_claim_templates=[
        m.PersistentVolumeClaim(
            metadata=m.ObjectMeta(name="work"),
            spec=m.PersistentVolumeClaimSpec(
                access_modes=["ReadWriteOnce"],
                resources=m.ResourceRequirements(
                    requests={
                        "storage": m.Quantity(__root__="64Mi"),
                    }
                ),
            ),
        )
    ],
) as w:
    cache_restore = Container(
        name="cache-restore",
        image="golang:1.18",
        command=["sh", "-euxc"],
        args=[
            """mkdir -p $(go env GOMODCACHE)
[ -e /mnt/GOMODCACHE ] && cp -Rf /mnt/GOMODCACHE $(go env GOMODCACHE)
mkdir -p $(go env GOCACHE)
[ -e /mnt/GOCACHE ] &&  cp -Rf /mnt/GOCACHE $(go env GOCACHE)
""",
        ],
        volume_mounts=[
            m.VolumeMount(name="work", mount_path="/go/pkg/mod", sub_path="mod"),
            m.VolumeMount(name="work", mount_path="/root/.cache/go-build", sub_path="cache"),
        ],
        inputs=[
            S3Artifact(
                name="GOMODCACHE",
                path="/mnt/GOMODCACHE",
                optional=True,
                key="github.com/golang/examples/{{workflow.parameters.branch}}/GOMODCACHE",
            ),
            S3Artifact(
                name="GOCACHE",
                path="/mnt/GOCACHE",
                optional=True,
                key="github.com/golang/examples/{{workflow.parameters.branch}}/GOCACHE",
            ),
        ],
        working_dir="/go/src/github.com/golang/example",
    )
    clone = Container(
        name="clone",
        image="golang:1.18",
        command=["sh", "-euxc"],
        args=[
            'git clone -v -b "{{workflow.parameters.branch}}" --single-branch --depth 1 https://github.com/golang/example.git .\n',
        ],
        volume_mounts=[
            m.VolumeMount(name="work", mount_path="/go/src/github.com/golang/example", sub_path="src"),
            m.VolumeMount(name="work", mount_path="/go/pkg/mod", sub_path="GOMODCACHE"),
            m.VolumeMount(name="work", mount_path="/root/.cache/go-build", sub_path="GOCACHE"),
        ],
        working_dir="/go/src/github.com/golang/example",
    )
    deps = Container(
        name="deps",
        image="golang:1.18",
        command=["sh", "-xuce"],
        args=["go mod download -x\n"],
        volume_mounts=[
            m.VolumeMount(name="work", mount_path="/go/src/github.com/golang/example", sub_path="src"),
            m.VolumeMount(name="work", mount_path="/go/pkg/mod", sub_path="GOMODCACHE"),
            m.VolumeMount(name="work", mount_path="/root/.cache/go-build", sub_path="GOCACHE"),
        ],
        working_dir="/go/src/github.com/golang/example",
    )
    build = Container(
        name="build",
        image="golang:1.18",
        command=["sh", "-xuce"],
        args=["go build ./...\n"],
        volume_mounts=[
            m.VolumeMount(name="work", mount_path="/go/src/github.com/golang/example", sub_path="src"),
            m.VolumeMount(name="work", mount_path="/go/pkg/mod", sub_path="GOMODCACHE"),
            m.VolumeMount(name="work", mount_path="/root/.cache/go-build", sub_path="GOCACHE"),
        ],
        working_dir="/go/src/github.com/golang/example",
    )
    test = Container(
        name="test",
        image="golang:1.18",
        command=["sh", "-euxc"],
        args=[
            """go install github.com/jstemmer/go-junit-report@latest
go install github.com/alexec/junit2html@v0.0.2

trap 'cat test.out | go-junit-report | junit2html > test-report.html' EXIT

go test -v ./... 2>&1 > test.out
""",
        ],
        volume_mounts=[
            m.VolumeMount(name="work", mount_path="/go/src/github.com/golang/example", sub_path="src"),
            m.VolumeMount(name="work", mount_path="/go/pkg/mod", sub_path="GOMODCACHE"),
            m.VolumeMount(name="work", mount_path="/root/.cache/go-build", sub_path="GOCACHE"),
        ],
        working_dir="/go/src/github.com/golang/example",
        outputs=[
            S3Artifact(
                name="test-report",
                path="/go/src/github.com/golang/example/test-report.html",
                archive=NoneArchiveStrategy(),
                key="{{workflow.parameters.branch}}/test-report.html",
            )
        ],
    )

    cache_store = Container(
        name="cache-store",
        image="golang:1.18",
        volume_mounts=[
            m.VolumeMount(name="work", mount_path="/go/pkg/mod", sub_path="GOMODCACHE"),
            m.VolumeMount(name="work", mount_path="/root/.cache/go-build", sub_path="GOCACHE"),
        ],
        outputs=[
            S3Artifact(
                name="GOMODCACHE",
                path="/go/pkg/mod",
                optional=True,
                key="github.com/golang/examples/{{workflow.parameters.branch}}/GOMODCACHE",
            ),
            S3Artifact(
                name="GOCACHE",
                path="/root/.cache/go-build",
                optional=True,
                key="github.com/golang/examples/{{workflow.parameters.branch}}/GOCACHE",
            ),
        ],
        working_dir="/go/src/github.com/golang/example",
    )

    with DAG(name="main"):
        cache_restore_task = Task(name="cache-restore", template=cache_restore)
        clone_task = Task(name="clone", template=clone)
        deps_task = Task(name="deps", template=deps, dependencies=["clone", "cache-restore"])
        build_task = Task(name="build", template=build, dependencies=["deps"])
        test_task = Task(name="test", template=test, dependencies=["build"])

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
apiVersion: argoproj.io/v1alpha1
kind: WorkflowTemplate
metadata:
  name: ci
spec:
  arguments:
    parameters:
    - name: branch
      value: master
  entrypoint: main
  onExit: cache-store
  templates:
  - container:
      args:
      - |
        mkdir -p $(go env GOMODCACHE)
        [ -e /mnt/GOMODCACHE ] && cp -Rf /mnt/GOMODCACHE $(go env GOMODCACHE)
        mkdir -p $(go env GOCACHE)
        [ -e /mnt/GOCACHE ] &&  cp -Rf /mnt/GOCACHE $(go env GOCACHE)
      command:
      - sh
      - -euxc
      image: golang:1.18
      volumeMounts:
      - mountPath: /go/pkg/mod
        name: work
        subPath: mod
      - mountPath: /root/.cache/go-build
        name: work
        subPath: cache
      workingDir: /go/src/github.com/golang/example
    inputs:
      artifacts:
      - name: GOMODCACHE
        optional: true
        path: /mnt/GOMODCACHE
        s3:
          key: github.com/golang/examples/{{workflow.parameters.branch}}/GOMODCACHE
      - name: GOCACHE
        optional: true
        path: /mnt/GOCACHE
        s3:
          key: github.com/golang/examples/{{workflow.parameters.branch}}/GOCACHE
    name: cache-restore
  - container:
      args:
      - |
        git clone -v -b "{{workflow.parameters.branch}}" --single-branch --depth 1 https://github.com/golang/example.git .
      command:
      - sh
      - -euxc
      image: golang:1.18
      volumeMounts:
      - mountPath: /go/src/github.com/golang/example
        name: work
        subPath: src
      - mountPath: /go/pkg/mod
        name: work
        subPath: GOMODCACHE
      - mountPath: /root/.cache/go-build
        name: work
        subPath: GOCACHE
      workingDir: /go/src/github.com/golang/example
    name: clone
  - container:
      args:
      - |
        go mod download -x
      command:
      - sh
      - -xuce
      image: golang:1.18
      volumeMounts:
      - mountPath: /go/src/github.com/golang/example
        name: work
        subPath: src
      - mountPath: /go/pkg/mod
        name: work
        subPath: GOMODCACHE
      - mountPath: /root/.cache/go-build
        name: work
        subPath: GOCACHE
      workingDir: /go/src/github.com/golang/example
    name: deps
  - container:
      args:
      - |
        go build ./...
      command:
      - sh
      - -xuce
      image: golang:1.18
      volumeMounts:
      - mountPath: /go/src/github.com/golang/example
        name: work
        subPath: src
      - mountPath: /go/pkg/mod
        name: work
        subPath: GOMODCACHE
      - mountPath: /root/.cache/go-build
        name: work
        subPath: GOCACHE
      workingDir: /go/src/github.com/golang/example
    name: build
  - container:
      args:
      - |
        go install github.com/jstemmer/go-junit-report@latest
        go install github.com/alexec/junit2html@v0.0.2

        trap 'cat test.out | go-junit-report | junit2html > test-report.html' EXIT

        go test -v ./... 2>&1 > test.out
      command:
      - sh
      - -euxc
      image: golang:1.18
      volumeMounts:
      - mountPath: /go/src/github.com/golang/example
        name: work
        subPath: src
      - mountPath: /go/pkg/mod
        name: work
        subPath: GOMODCACHE
      - mountPath: /root/.cache/go-build
        name: work
        subPath: GOCACHE
      workingDir: /go/src/github.com/golang/example
    name: test
    outputs:
      artifacts:
      - archive:
          none: {}
        name: test-report
        path: /go/src/github.com/golang/example/test-report.html
        s3:
          key: '{{workflow.parameters.branch}}/test-report.html'
  - container:
      image: golang:1.18
      volumeMounts:
      - mountPath: /go/pkg/mod
        name: work
        subPath: GOMODCACHE
      - mountPath: /root/.cache/go-build
        name: work
        subPath: GOCACHE
      workingDir: /go/src/github.com/golang/example
    name: cache-store
    outputs:
      artifacts:
      - name: GOMODCACHE
        optional: true
        path: /go/pkg/mod
        s3:
          key: github.com/golang/examples/{{workflow.parameters.branch}}/GOMODCACHE
      - name: GOCACHE
        optional: true
        path: /root/.cache/go-build
        s3:
          key: github.com/golang/examples/{{workflow.parameters.branch}}/GOCACHE
  - dag:
      tasks:
      - name: cache-restore
        template: cache-restore
      - name: clone
        template: clone
      - dependencies:
        - clone
        - cache-restore
        name: deps
        template: deps
      - dependencies:
        - deps
        name: build
        template: build
      - dependencies:
        - build
        name: test
        template: test
    name: main
  volumeClaimTemplates:
  - metadata:
      name: work
    spec:
      accessModes:
      - ReadWriteOnce
      resources:
        requests:
          storage: 64Mi

Comments