From a4ec061fc73082fa265570002a2c29dfc51091af Mon Sep 17 00:00:00 2001
From: Piotr Grabowski <piotr.grabowski@scylladb.com>
Date: Fri, 25 Nov 2022 19:52:32 +0100
Subject: [PATCH] Add a suite of IntelliJ run configurations

Add a suite of IntelliJ run configurations to make it easier for new
developers to onboard the project and better Maven discoverability.
The run configurations should appear automatically after loading the
project in IntelliJ, in the Run > Run... menu.

The configurations are organized to three groups:
1. build: clean, format, build, full build
2. test: unit tests, integration tests - including configurations to run
   them against Scylla, Cassandra, run only a single test
3. install: package, install
---
 .run/build.run.xml                            | 64 +++++++++++++++++++
 .run/clean.run.xml                            | 45 +++++++++++++
 .run/format.run.xml                           | 27 ++++++++
 .run/full build.run.xml                       | 30 +++++++++
 .run/install.run.xml                          | 27 ++++++++
 .run/integration tests (all, C_).run.xml      | 32 ++++++++++
 .run/integration tests (all, Scylla).run.xml  | 32 ++++++++++
 .run/integration tests (single, C_).run.xml   | 34 ++++++++++
 ...integration tests (single, Scylla).run.xml | 34 ++++++++++
 .run/package.run.xml                          | 27 ++++++++
 .run/unit test (single).run.xml               | 32 ++++++++++
 .run/unit tests (all).run.xml                 | 30 +++++++++
 CONTRIBUTING.md                               |  4 ++
 13 files changed, 418 insertions(+)
 create mode 100644 .run/build.run.xml
 create mode 100644 .run/clean.run.xml
 create mode 100644 .run/format.run.xml
 create mode 100644 .run/full build.run.xml
 create mode 100644 .run/install.run.xml
 create mode 100644 .run/integration tests (all, C_).run.xml
 create mode 100644 .run/integration tests (all, Scylla).run.xml
 create mode 100644 .run/integration tests (single, C_).run.xml
 create mode 100644 .run/integration tests (single, Scylla).run.xml
 create mode 100644 .run/package.run.xml
 create mode 100644 .run/unit test (single).run.xml
 create mode 100644 .run/unit tests (all).run.xml

diff --git a/.run/build.run.xml b/.run/build.run.xml
new file mode 100644
index 00000000000..8a85a74b8e8
--- /dev/null
+++ b/.run/build.run.xml
@@ -0,0 +1,64 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="build" type="MavenRunConfiguration" factoryName="Maven" folderName="build">
+    <MavenSettings>
+      <option name="myGeneralSettings">
+        <MavenGeneralSettings>
+          <option name="alwaysUpdateSnapshots" value="false" />
+          <option name="checksumPolicy" value="NOT_SET" />
+          <option name="failureBehavior" value="NOT_SET" />
+          <option name="localRepository" value="" />
+          <option name="mavenHome" value="Bundled (Maven 3)" />
+          <option name="nonRecursive" value="false" />
+          <option name="outputLevel" value="INFO" />
+          <option name="pluginUpdatePolicy" value="DEFAULT" />
+          <option name="printErrorStackTraces" value="false" />
+          <option name="showDialogWithAdvancedSettings" value="false" />
+          <option name="threads" />
+          <option name="useMavenConfig" value="true" />
+          <option name="usePluginRegistry" value="false" />
+          <option name="userSettingsFile" value="" />
+          <option name="workOffline" value="false" />
+        </MavenGeneralSettings>
+      </option>
+      <option name="myRunnerSettings">
+        <MavenRunnerSettings>
+          <option name="delegateBuildToMaven" value="false" />
+          <option name="environmentProperties">
+            <map />
+          </option>
+          <option name="jreName" value="#USE_PROJECT_JDK" />
+          <option name="mavenProperties">
+            <map />
+          </option>
+          <option name="passParentEnv" value="true" />
+          <option name="runMavenInBackground" value="true" />
+          <option name="skipTests" value="false" />
+          <option name="vmOptions" value="" />
+        </MavenRunnerSettings>
+      </option>
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="compile" />
+              <option value="test-compile" />
+              <option value="-Dfmt.skip=true" />
+              <option value="-Dclirr.skip=true" />
+              <option value="-Danimal.sniffer.skip=true" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/clean.run.xml b/.run/clean.run.xml
new file mode 100644
index 00000000000..c8fb98c3f23
--- /dev/null
+++ b/.run/clean.run.xml
@@ -0,0 +1,45 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="clean" type="MavenRunConfiguration" factoryName="Maven" folderName="build">
+    <MavenSettings>
+      <option name="myGeneralSettings">
+        <MavenGeneralSettings>
+          <option name="alwaysUpdateSnapshots" value="false" />
+          <option name="checksumPolicy" value="NOT_SET" />
+          <option name="failureBehavior" value="NOT_SET" />
+          <option name="localRepository" value="" />
+          <option name="mavenHome" value="Bundled (Maven 3)" />
+          <option name="nonRecursive" value="false" />
+          <option name="outputLevel" value="INFO" />
+          <option name="pluginUpdatePolicy" value="DEFAULT" />
+          <option name="printErrorStackTraces" value="false" />
+          <option name="showDialogWithAdvancedSettings" value="false" />
+          <option name="threads" />
+          <option name="useMavenConfig" value="true" />
+          <option name="usePluginRegistry" value="false" />
+          <option name="userSettingsFile" value="" />
+          <option name="workOffline" value="false" />
+        </MavenGeneralSettings>
+      </option>
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="clean" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/format.run.xml b/.run/format.run.xml
new file mode 100644
index 00000000000..bcdcaa2b18d
--- /dev/null
+++ b/.run/format.run.xml
@@ -0,0 +1,27 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="format" type="MavenRunConfiguration" factoryName="Maven" folderName="build">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="fmt:format" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/full build.run.xml b/.run/full build.run.xml
new file mode 100644
index 00000000000..6807769958e
--- /dev/null
+++ b/.run/full build.run.xml	
@@ -0,0 +1,30 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="full build" type="MavenRunConfiguration" factoryName="Maven" folderName="build">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="verify" />
+              <option value="-DskipTests" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2">
+      <option name="RunConfigurationTask" enabled="true" run_configuration_name="clean" run_configuration_type="MavenRunConfiguration" />
+    </method>
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/install.run.xml b/.run/install.run.xml
new file mode 100644
index 00000000000..61ac7b68bcc
--- /dev/null
+++ b/.run/install.run.xml
@@ -0,0 +1,27 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="install" type="MavenRunConfiguration" factoryName="Maven" folderName="install">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="install" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/integration tests (all, C_).run.xml b/.run/integration tests (all, C_).run.xml
new file mode 100644
index 00000000000..7a3bf2295d4
--- /dev/null
+++ b/.run/integration tests (all, C_).run.xml	
@@ -0,0 +1,32 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="integration tests (all, C*)" type="MavenRunConfiguration" factoryName="Maven" folderName="test">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="verify" />
+              <option value="-Pshort" />
+              <option value="-Dcassandra.version=3.11.14" />
+              <option value="-Dfmt.skip=true" />
+              <option value="-Dclirr.skip=true" />
+              <option value="-Danimal.sniffer.skip=true" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/integration tests (all, Scylla).run.xml b/.run/integration tests (all, Scylla).run.xml
new file mode 100644
index 00000000000..f744f3e2aea
--- /dev/null
+++ b/.run/integration tests (all, Scylla).run.xml	
@@ -0,0 +1,32 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="integration tests (all, Scylla)" type="MavenRunConfiguration" factoryName="Maven" folderName="test">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="verify" />
+              <option value="-Pshort" />
+              <option value="-Dscylla.version=5.0.5" />
+              <option value="-Dfmt.skip=true" />
+              <option value="-Dclirr.skip=true" />
+              <option value="-Danimal.sniffer.skip=true" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/integration tests (single, C_).run.xml b/.run/integration tests (single, C_).run.xml
new file mode 100644
index 00000000000..427787fc87d
--- /dev/null
+++ b/.run/integration tests (single, C_).run.xml	
@@ -0,0 +1,34 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="integration tests (single, C*)" type="MavenRunConfiguration" factoryName="Maven" folderName="test">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="verify" />
+              <option value="-Dtest=EnumCodecsTest" />
+              <option value="-Pshort" />
+              <option value="-Dcassandra.version=3.11.14" />
+              <option value="-Dfmt.skip=true" />
+              <option value="-Dclirr.skip=true" />
+              <option value="-Danimal.sniffer.skip=true" />
+              <option value="-Dsurefire.failIfNoSpecifiedTests=false" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/integration tests (single, Scylla).run.xml b/.run/integration tests (single, Scylla).run.xml
new file mode 100644
index 00000000000..e995a1ebce5
--- /dev/null
+++ b/.run/integration tests (single, Scylla).run.xml	
@@ -0,0 +1,34 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="integration tests (single, Scylla)" type="MavenRunConfiguration" factoryName="Maven" folderName="test">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="verify" />
+              <option value="-Dtest=EnumCodecsTest" />
+              <option value="-Pshort" />
+              <option value="-Dscylla.version=5.0.5" />
+              <option value="-Dfmt.skip=true" />
+              <option value="-Dclirr.skip=true" />
+              <option value="-Danimal.sniffer.skip=true" />
+              <option value="-Dsurefire.failIfNoSpecifiedTests=false" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/package.run.xml b/.run/package.run.xml
new file mode 100644
index 00000000000..f51826a0c70
--- /dev/null
+++ b/.run/package.run.xml
@@ -0,0 +1,27 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="package" type="MavenRunConfiguration" factoryName="Maven" folderName="install">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="package" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/unit test (single).run.xml b/.run/unit test (single).run.xml
new file mode 100644
index 00000000000..e2e71ad1759
--- /dev/null
+++ b/.run/unit test (single).run.xml	
@@ -0,0 +1,32 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="unit test (single)" type="MavenRunConfiguration" factoryName="Maven" folderName="test">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="test" />
+              <option value="-Dtest=DataTypeTest" />
+              <option value="-Dfmt.skip=true" />
+              <option value="-Dclirr.skip=true" />
+              <option value="-Danimal.sniffer.skip=true" />
+              <option value="-Dsurefire.failIfNoSpecifiedTests=false" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/unit tests (all).run.xml b/.run/unit tests (all).run.xml
new file mode 100644
index 00000000000..595d6624269
--- /dev/null
+++ b/.run/unit tests (all).run.xml	
@@ -0,0 +1,30 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="unit tests (all)" type="MavenRunConfiguration" factoryName="Maven" folderName="test">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="test" />
+              <option value="-Dfmt.skip=true" />
+              <option value="-Dclirr.skip=true" />
+              <option value="-Danimal.sniffer.skip=true" />
+            </list>
+          </option>
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index be63f984c2b..2980daabef1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -71,6 +71,10 @@ If you want to contribute but don't have a specific issue in mind, it's best to
 
 ## Editor configuration
 
+For IntelliJ IDEA users, a suite of run configurations is bundled with the project (`.run` directory).
+The run configurations should appear automatically in Run > Run... after loading the project in IntelliJ. They provide
+a convenient way to build and test the project.
+
 We use IntelliJ IDEA with the default formatting options, with one exception: check
 "Enable formatter markers in comments" in Preferences > Editor > Code Style.