Introduce new module for shared interfaces

legend-shared-utility-interfaces/README.md

@@ -0,0 +1,12 @@
+# Overview
+
+This module is intended to be a collection of utility interfaces/classes to be widely used across Legend repos.
+
+Candidates for inclusion in this module include :
+* Annotations such as "@ExperimentalApi"
+* Test interfaces to be used with Junit Categories
+
+# Dependencies 
+
+Since we intend to use this module widely across Legend, this module should not bring in too many (or any ?) library dependencies.
+

legend-shared-utility-interfaces/pom.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2020 Goldman Sachs
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.finos.legend.shared</groupId>
+        <artifactId>legend-shared</artifactId>
+        <version>0.23.4-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>legend-shared-utility-interfaces</artifactId>
+    <name>Legend Shared - Utility Interfaces</name>
+    <url>https://legend.finos.org</url>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+    </dependencies>
+</project>

legend-shared-utility-interfaces/src/main/java/org/finos/legend/shared/api/annotations/ExperimentalApi.java

@@ -0,0 +1,27 @@
+// Copyright 2023 Goldman Sachs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package org.finos.legend.shared.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Target;
+
+/**
+ * Marker interface for preview and experimental APIs. Breaking changes may be
+ * introduced to elements marked as {@link ExperimentalApi}. Users should assume that anything annotated as experimental will change or break in subsequent releases.
+ */
+@Target({ElementType.PACKAGE, ElementType.TYPE, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.METHOD})
+public @interface ExperimentalApi
+{
+}

legend-shared-utility-interfaces/src/main/java/org/finos/legend/shared/test/junit/DatabaseIntegrationTest.java

@@ -0,0 +1,24 @@
+// Copyright 2023 Goldman Sachs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package org.finos.legend.shared.test.junit;
+
+/*
+    Marker interface to be used with Junit Categories. See https://junit.org/junit4/javadoc/4.12/org/junit/experimental/categories/Categories.html
+
+    Used to indicate integration tests that test database functionality e.g. SQL generation, authentication etc
+ */
+public interface DatabaseIntegrationTest
+{
+}

legend-shared-utility-interfaces/src/main/java/org/finos/legend/shared/test/junit/IntegrationTest.java

@@ -0,0 +1,24 @@
+// Copyright 2023 Goldman Sachs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package org.finos.legend.shared.test.junit;
+
+/*
+    Marker interface to be used with Junit Categories. See https://junit.org/junit4/javadoc/4.12/org/junit/experimental/categories/Categories.html
+
+    Used to indicate a test that launches infrastructure (e.g. databases, Docker containers etc.) or depends on external infrastructure
+ */
+public interface IntegrationTest
+{
+}

legend-shared-utility-interfaces/src/main/java/org/finos/legend/shared/test/junit/RunUsingCICDServer.java

@@ -0,0 +1,24 @@
+// Copyright 2023 Goldman Sachs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package org.finos.legend.shared.test.junit;
+
+/*
+    Marker interface to be used with Junit Categories. See https://junit.org/junit4/javadoc/4.12/org/junit/experimental/categories/Categories.html
+
+    Used to indicate a test that can only be run on a CI/CD server because that test requires configuration (e.g. secrets) that are injected by the CI/CD server.
+ */
+public interface RunUsingCICDServer
+{
+}

legend-shared-utility-interfaces/src/main/java/org/finos/legend/shared/test/junit/RunUsingGithubActions.java

@@ -0,0 +1,24 @@
+// Copyright 2023 Goldman Sachs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package org.finos.legend.shared.test.junit;
+
+/*
+    Marker interface to be used with Junit Categories. See https://junit.org/junit4/javadoc/4.12/org/junit/experimental/categories/Categories.html
+
+    Used to indicate a test that can only be run on a CI/CD server because that test requires configuration (e.g. secrets) that are injected by the CI/CD server.
+ */
+public interface RunUsingGithubActions extends RunUsingCICDServer
+{
+}

legend-shared-utility-interfaces/src/main/java/org/finos/legend/shared/test/junit/RunUsingTeamCity.java

@@ -0,0 +1,24 @@
+// Copyright 2023 Goldman Sachs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package org.finos.legend.shared.test.junit;
+
+/*
+    Marker interface to be used with Junit Categories. See https://junit.org/junit4/javadoc/4.12/org/junit/experimental/categories/Categories.html
+
+    Used to indicate a test that can only be run on a CI/CD server because that test requires configuration (e.g. secrets) that are injected by the CI/CD server.
+ */
+public interface RunUsingTeamCity extends RunUsingCICDServer
+{
+}

pom.xml

@@ -114,6 +114,7 @@
         <module>legend-shared-opentracing-servlet-filter</module>
 
         <module>legend-shared-server</module>
+        <module>legend-shared-utility-interfaces</module>
     </modules>
 
     <build>
@@ -324,6 +325,11 @@
                 <artifactId>legend-shared-server</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.finos.legend.shared</groupId>
+                <artifactId>legend-shared-utility-interfaces</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>org.finos.legend.shared</groupId>
                 <artifactId>legend-shared-pac4j</artifactId>