feat(example): create resource dependencies #15002

gianarb · gianarb · commit 0cf57e621f3a · 2025-12-05T16:12:31.000+01:00
Some of our examples depends on other resources such as
ClusterWorkflowTemplate, WorkflowTemplate, ConfigMap and so on.

Those tests were previous to this commit disabled because we were not
resolving such dependencies but right now we visit the example dir and
subdirs twice, the first time we apply all those resources, the second
time to run the actual workflows

Signed-off-by: Gianluca Arbezzano &lt;ciao@gianarb.it&gt;
diff --git a/docs/fields.md b/docs/fields.md
@@ -3987,14 +3987,6 @@ MetricLabel is a single label for a prometheus metric
 
 - [`ci.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/ci.yaml)
 
-- [`cluster-wftmpl-dag.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/cluster-workflow-template/cluster-wftmpl-dag.yaml)
-
-- [`mixed-cluster-namespaced-wftmpl-steps.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml)
-
-- [`workflow-template-ref-with-entrypoint-arg-passing.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/cluster-workflow-template/workflow-template-ref-with-entrypoint-arg-passing.yaml)
-
-- [`workflow-template-ref.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/cluster-workflow-template/workflow-template-ref.yaml)
-
 - [`colored-logs.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/colored-logs.yaml)
 
 - [`continue-on-fail.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/continue-on-fail.yaml)
@@ -4149,25 +4141,11 @@ MetricLabel is a single label for a prometheus metric
 
 - [`title-and-description-with-markdown.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/title-and-description-with-markdown.yaml)
 
-- [`volumes-existing.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/volumes-existing.yaml)
-
 - [`webhdfs-input-output-artifacts.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/webhdfs-input-output-artifacts.yaml)
 
 - [`work-avoidance.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/work-avoidance.yaml)
 
 - [`workflow-of-workflows.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/workflow-of-workflows.yaml)
-
-- [`dag.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/workflow-template/dag.yaml)
-
-- [`hello-world.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/workflow-template/hello-world.yaml)
-
-- [`retry-with-steps.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/workflow-template/retry-with-steps.yaml)
-
-- [`steps.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/workflow-template/steps.yaml)
-
-- [`workflow-template-ref-with-entrypoint-arg-passing.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/workflow-template/workflow-template-ref-with-entrypoint-arg-passing.yaml)
-
-- [`workflow-template-ref.yaml`](https://github.com/argoproj/argo-workflows/blob/main/examples/workflow-template/workflow-template-ref.yaml)
 </details>
 
 ### Fields
diff --git a/examples/cluster-workflow-template/cluster-wftmpl-dag.yaml b/examples/cluster-workflow-template/cluster-wftmpl-dag.yaml
@@ -9,8 +9,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-dag-diamond-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: diamond
   templates:
diff --git a/examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml b/examples/cluster-workflow-template/mixed-cluster-namespaced-wftmpl-steps.yaml
@@ -2,8 +2,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-steps-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: hello-hello-hello
   templates:
diff --git a/examples/cluster-workflow-template/workflow-template-ref-with-entrypoint-arg-passing.yaml b/examples/cluster-workflow-template/workflow-template-ref-with-entrypoint-arg-passing.yaml
@@ -2,8 +2,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: cluster-workflow-template-hello-world-
-  labels:
-    workflows.argoproj.io/no-test: "broken"
 spec:
   entrypoint: print-message
   arguments:
diff --git a/examples/cluster-workflow-template/workflow-template-ref.yaml b/examples/cluster-workflow-template/workflow-template-ref.yaml
@@ -2,8 +2,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: cluster-workflow-template-hello-world-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   workflowTemplateRef:
     name: cluster-workflow-template-submittable
diff --git a/examples/custom-metrics.yaml b/examples/custom-metrics.yaml
@@ -5,6 +5,8 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: hello-world-
+  labels:
+    workflows.argoproj.io/no-test: "flaky"
 spec:
   entrypoint: steps
   metrics:
diff --git a/examples/http-success-condition.yaml b/examples/http-success-condition.yaml
@@ -13,7 +13,7 @@ spec:
         - - name: http-status-is-201-succeeds
             template: http-status-is-201
             arguments:
-              parameters: [{name: url, value: "http://httpbin:9100/status/201"}]  # Returns status code 201
+              parameters: [{name: url, value: "https://httpbin.org/status/201"}]  # Returns status code 201
           - name: http-body-contains-google-succeeds
             template: http-body-contains-google
             arguments:
diff --git a/examples/timeouts-step.yaml b/examples/timeouts-step.yaml
@@ -7,7 +7,7 @@ kind: Workflow
 metadata:
   generateName: timeouts-step-
   labels:
-    workflows.argoproj.io/no-test: "broken"
+    workflows.argoproj.io/no-test: "expected-failure"
   annotations:
     workflows.argoproj.io/no-test-reason: |
       It looks like the container does not terminate in a clean way
diff --git a/examples/volumes-existing.yaml b/examples/volumes-existing.yaml
@@ -11,8 +11,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: volumes-existing-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: volumes-existing-example
   volumes:
diff --git a/examples/workflow-template/dag.yaml b/examples/workflow-template/dag.yaml
@@ -9,8 +9,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-dag-diamond-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: diamond
   templates:
diff --git a/examples/workflow-template/hello-world.yaml b/examples/workflow-template/hello-world.yaml
@@ -2,8 +2,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-hello-world-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: hello-world-from-templateRef
   templates:
diff --git a/examples/workflow-template/retry-with-steps.yaml b/examples/workflow-template/retry-with-steps.yaml
@@ -3,8 +3,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-retry-with-steps-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: retry-with-steps
   templates:
diff --git a/examples/workflow-template/steps.yaml b/examples/workflow-template/steps.yaml
@@ -2,8 +2,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-steps-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: hello-hello-hello
   templates:
diff --git a/examples/workflow-template/workflow-template-ref-with-entrypoint-arg-passing.yaml b/examples/workflow-template/workflow-template-ref-with-entrypoint-arg-passing.yaml
@@ -2,8 +2,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-hello-world-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   entrypoint: print-message
   arguments:
diff --git a/examples/workflow-template/workflow-template-ref.yaml b/examples/workflow-template/workflow-template-ref.yaml
@@ -2,8 +2,6 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: workflow-template-hello-world-
-  labels:
-    workflows.argoproj.io/no-test: "environment"
 spec:
   workflowTemplateRef:
     name: workflow-template-submittable
diff --git a/test/e2e/examples_test.go b/test/e2e/examples_test.go
@@ -3,9 +3,13 @@
 package e2e
 
 import (
+	"bytes"
 	"fmt"
+	"strings"
 	"testing"
 
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+
 	"k8s.io/client-go/kubernetes"
 
 	"github.com/argoproj/argo-workflows/v3/config"
@@ -18,6 +22,9 @@ import (
 	"github.com/argoproj/argo-workflows/v3/workflow/common"
 	"github.com/argoproj/argo-workflows/v3/workflow/hydrator"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/client-go/dynamic"
+	"sigs.k8s.io/yaml"
 )
 
 func TestExampleWorkflows(t *testing.T) {
@@ -29,6 +36,8 @@ func TestExampleWorkflows(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
+	dyn := dynamic.NewForConfigOrDie(restConfig)
+
 	configController := config.NewController(fixtures.Namespace, common.ConfigMapName, kubeClient)
 	ctx := logging.TestContext(t.Context())
 	config, err := configController.Get(ctx)
@@ -46,6 +55,71 @@ func TestExampleWorkflows(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	kindToApply := map[string]bool{
+		"ConfigMap":               true,
+		"PersistentVolumeClaim":   true,
+		"WorkflowTemplate":        true,
+		"ClusterWorkflowTemplate": true,
+	}
+
+	err = fileutil.WalkManifests(ctx, "../../examples", func(path string, data []byte) error {
+		docs := splitYAMLDocuments(data)
+		for _, doc := range docs {
+			if len(doc) == 0 {
+				continue
+			}
+			obj := &unstructured.Unstructured{}
+			err = yaml.Unmarshal(doc, &obj)
+			if err != nil || obj == nil {
+				continue
+			}
+
+			if _, ok := kindToApply[obj.GetKind()]; !ok {
+				continue
+			}
+
+			gvr := obj.GroupVersionKind().GroupVersion().WithResource(strings.ToLower(obj.GetKind() + "s"))
+			if obj.GetKind() == "ClusterWorkflowTemplate" {
+				// cluster scoped resources don't need a namespace
+				_, err = dyn.Resource(gvr).
+					Apply(
+						ctx,
+						obj.GetName(),
+						obj,
+						metav1.ApplyOptions{
+							FieldManager: "go-examples",
+							Force:        true,
+						})
+			} else {
+				_, err = dyn.Resource(gvr).
+					Namespace(fixtures.Namespace).
+					Apply(
+						ctx,
+						obj.GetName(),
+						obj,
+						metav1.ApplyOptions{
+							FieldManager: "go-examples",
+							Force:        true,
+						})
+			}
+			if err != nil {
+				if apierrors.IsConflict(err) {
+					t.Logf("object %s/%s already exists or applied by another manager — skipping", obj.GetKind(), obj.GetName())
+					continue
+				}
+				if apierrors.IsAlreadyExists(err) {
+					t.Logf("object %s/%s exists — skipping", obj.GetKind(), obj.GetName())
+					continue
+				}
+				t.Fatalf("apply error %s/%s: %v", obj.GetKind(), obj.GetName(), err)
+			}
+		}
+		return nil
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	err = fileutil.WalkManifests(ctx, "../../examples", func(path string, data []byte) error {
 		wfs, err := common.SplitWorkflowYAMLFile(ctx, data, true)
 		if err != nil {
@@ -58,7 +132,7 @@ func TestExampleWorkflows(t *testing.T) {
 				if noTextLabelExists {
 					t.Skip(fmt.Sprintf("Impossible to run this example: %s", noTestKeyword))
 				}
-				given := fixtures.NewGiven(
+				fixtures.NewGiven(
 					t,
 					versioned.NewForConfigOrDie(restConfig).ArgoprojV1alpha1().Workflows(fixtures.Namespace),
 					versioned.NewForConfigOrDie(restConfig).ArgoprojV1alpha1().WorkflowEventBindings(fixtures.Namespace),
@@ -70,11 +144,7 @@ func TestExampleWorkflows(t *testing.T) {
 					kubeClient,
 					string(sec.Data["token"]),
 					restConfig,
-					config,
-				)
-
-				given.KubectlApply("../../examples/configmaps/simple-parameters-configmap.yaml", fixtures.NoError)
-				given.
+					config).
 					ExampleWorkflow(&wf).
 					When().
 					SubmitWorkflow().
@@ -87,3 +157,16 @@ func TestExampleWorkflows(t *testing.T) {
 		t.Fatal(err)
 	}
 }
+
+// helper: split multi-doc YAML
+func splitYAMLDocuments(data []byte) [][]byte {
+	sections := bytes.Split(data, []byte("---"))
+	var docs [][]byte
+	for _, s := range sections {
+		trimmed := bytes.TrimSpace(s)
+		if len(trimmed) > 0 {
+			docs = append(docs, trimmed)
+		}
+	}
+	return docs
+}
