From c4778abaec61d18b39b9331fbc6c626e1efa3267 Mon Sep 17 00:00:00 2001
From: Gloria Ciavarrini <gciavarrini@redhat.com>
Date: Wed, 2 Aug 2023 10:42:19 +0200
Subject: [PATCH] `prebuilt-tasks` module must NOT depend on
 `workflow-service-sdk`

This module (prebuilt-tasks) must not depend on `workflow-service-sdk`,
as it is already dependent on `workflow-service`. `workflow-service`
depends on `prebuilt-tasks`. Adding `workflow-service-sdk` here will
create a circular dependency, and `workflow-service` won't be able to
generate the `openapi.json` file anymore.

This commit introduces a check that will now prevent the build from succeeding if there is a dependency on workflow-service-sdk.

Signed-off-by: Gloria Ciavarrini <gciavarrini@redhat.com>
---
 prebuilt-tasks/pom.xml | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/prebuilt-tasks/pom.xml b/prebuilt-tasks/pom.xml
index 60dc4a42b..c5ffc71e8 100644
--- a/prebuilt-tasks/pom.xml
+++ b/prebuilt-tasks/pom.xml
@@ -218,6 +218,36 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>3.3.0</version> <!-- Adjust version as needed -->
+                <executions>
+                    <execution>
+                        <id>enforce-no-unwanted-dependency</id>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <bannedDependencies>
+                                    <excludes>
+                                        <!--
+                                         IMPORTANT NOTE: This module (prebuilt-tasks) must not depend on workflow-service-sdk,
+                                         as it is already dependent on workflow-service. workflow-service depends on
+                                         prebuilt-tasks. Adding workflow-service-sdk here will create a circular
+                                         dependency, and workflow-service won't be able to generate the openapi.json file anymore.
+                                          -->
+                                        <exclude>dev.parodos:workflow-service-sdk</exclude>
+                                    </excludes>
+                                </bannedDependencies>
+                            </rules>
+                            <fail>true</fail>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>