[AUTO] Incremented version to 2.10.1.

.github/workflows/ci.yml

@@ -8,15 +8,57 @@ on:
       - "*"
 
 jobs:
-  build:
+  Get-CI-Image-Tag:
+    uses: opensearch-project/opensearch-build/.github/workflows/get-ci-image-tag.yml@main
+    with:
+      product: opensearch
+
+  build-linux:
+    needs: Get-CI-Image-Tag
+    strategy:
+      matrix:
+        java: 
+          - 11
+          - 17
+          - 21
+    name: Build and Test
+    runs-on: ubuntu-latest
+    container:
+      # using the same image which is used by opensearch-build team to build the OpenSearch Distribution
+      # this image tag is subject to change as more dependencies and updates will arrive over time
+      image: ${{ needs.Get-CI-Image-Tag.outputs.ci-image-version-linux }}
+      # need to switch to root so that github actions can install runner binary on container without permission issues.
+      options: --user root
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Java ${{ matrix.java }}
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java }}
+
+      - name: Build and Test
+        run: |
+          chown -R 1000:1000 `pwd`
+          su `id -un 1000` -c "./gradlew build &&
+                               ./gradlew publishToMavenLocal"
+
+      - name: Upload Coverage Report
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  build-windows:
     strategy:
       matrix:
         java: 
           - 11
           - 17
-        os: [ubuntu-latest, windows-latest]
+          - 21
     name: Build and Test
-    runs-on: ${{ matrix.os }}
+    runs-on: windows-latest
 
     steps:
       - name: Checkout

build.gradle

@@ -6,7 +6,7 @@
 buildscript {
     ext {
         opensearch_group = "org.opensearch"
-        opensearch_version = System.getProperty("opensearch.version", "2.10.0-SNAPSHOT")
+        opensearch_version = System.getProperty("opensearch.version", "2.13.1-SNAPSHOT")
         isSnapshot = "true" == System.getProperty("build.snapshot", "true")
         buildVersionQualifier = System.getProperty("build.version_qualifier", "")
         kotlin_version = System.getProperty("kotlin.version", "1.8.21")
@@ -30,7 +30,7 @@ buildscript {
 plugins {
     id 'java-library'
     id 'maven-publish'
-    id 'com.diffplug.spotless' version '6.18.0'
+    id 'com.diffplug.spotless' version '6.22.0'
 }
 
 repositories {
@@ -66,7 +66,12 @@ apply plugin: 'opensearch.repositories'
 apply from: 'build-tools/opensearchplugin-coverage.gradle'
 
 configurations {
-    ktlint
+    ktlint {
+      resolutionStrategy {
+          force "ch.qos.logback:logback-classic:1.3.14"
+          force "ch.qos.logback:logback-core:1.3.14"
+      }
+   }
 }
 
 dependencies {
@@ -86,7 +91,7 @@ dependencies {
     testImplementation "commons-validator:commons-validator:1.7"
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.2'
 
-    ktlint "com.pinterest:ktlint:0.44.0"
+    ktlint "com.pinterest:ktlint:0.47.1"
 }
 
 test {
@@ -226,4 +231,4 @@ task updateVersion {
         // Include the required files that needs to be updated with new Version
         ant.replaceregexp(file:'build.gradle', match: '"opensearch.version", "\\d.*"', replace: '"opensearch.version", "' + newVersion.tokenize('-')[0] + '-SNAPSHOT"', flags:'g', byline:true)
     }
-}
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
+distributionSha256Sum=3e1af3ae886920c3ac87f7a91f816c0c7c436f276a6eefdb3da152100fef72ae

gradlew

@@ -83,7 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -130,26 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -198,11 +202,11 @@ fi
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

release-notes/opensearch-common-utils.release-notes-2.10.0.0.md

@@ -0,0 +1,14 @@
+## Version 2.10.0.0 2023-08-31
+
+Compatible with OpenSearch 2.10.0
+
+### Maintenance
+* Upgrade the backport workflow ([#487](https://github.com/opensearch-project/common-utils/pull/487))
+* Updates demo certs used in rest tests ([#518](https://github.com/opensearch-project/common-utils/pull/518))
+
+### Feature
+* common utils to support Microsoft teams in notifications ([#428](https://github.com/opensearch-project/common-utils/pull/428))
+* support list of monitor ids in Chained Monitor Findings ([#514](https://github.com/opensearch-project/common-utils/pull/514))
+
+### Documentation
+* Added 2.10.0.0 release notes ([#531](https://github.com/opensearch-project/common-utils/pull/531))

release-notes/opensearch-common-utils.release-notes-2.12.0.0.md

@@ -0,0 +1,25 @@
+## Version 2.12.0.0 2023-02-06
+
+Compatible with OpenSearch 2.12.0
+
+### Maintenance
+* Increment version to 2.12.0-SNAPSHOT ([#545](https://github.com/opensearch-project/common-utils/pull/545))
+* Onboard prod jenkins docker image to github actions ([#557](https://github.com/opensearch-project/common-utils/pull/557))
+* Update Gradle to 8.4 ([#560](https://github.com/opensearch-project/common-utils/pull/560))
+* Add Java 11/17/21 matrix for build, test and integration checks ([#561](https://github.com/opensearch-project/common-utils/pull/561))
+* changed all usages of 'admin' as a password to something different ([#581](https://github.com/opensearch-project/common-utils/pull/581))
+* Update dependency com.pinterest:ktlint to 0.47.1 and fix CVE-2023-6378 ([#585](https://github.com/opensearch-project/common-utils/pull/585))
+
+### Enhancement
+* add 'fields' parameter in doc level query object. ([#546](https://github.com/opensearch-project/common-utils/pull/546))
+* add fields param in toxcontent() for doc level query ([#549](https://github.com/opensearch-project/common-utils/pull/549))
+* Add User.isAdminDn to User class ([#547](https://github.com/opensearch-project/common-utils/pull/547))
+
+### Refactor
+* Move get monitor and search monitor action / request / responses to common-utils ([#566](https://github.com/opensearch-project/common-utils/pull/566))
+
+# Features
+* Implemented cross-cluster monitor support ([#584](https://github.com/opensearch-project/common-utils/pull/584))
+
+### Documentation
+* Added 2.12.0.0 release notes ([#585](https://github.com/opensearch-project/common-utils/pull/585))

release-notes/opensearch-common-utils.release-notes-2.13.0.0.md

@@ -0,0 +1,16 @@
+## Version 2.13.0.0 2023-03-21
+
+Compatible with OpenSearch 2.13.0
+
+### Maintenance
+* Increment version to 2.13.0-SNAPSHOT ([#591](https://github.com/opensearch-project/common-utils/pull/591))
+
+### Enhancement
+* add queryFieldNames field in Doc Level Queries (#[582](https://github.com/opensearch-project/common-utils/pull/582)) (#[597](https://github.com/opensearch-project/common-utils/pull/597))
+
+# Features
+* fix findings API enhancemnts (#[611](https://github.com/opensearch-project/common-utils/pull/611)) (#[617](https://github.com/opensearch-project/common-utils/pull/617))
+* Feature findings enhancemnt (#[596](https://github.com/opensearch-project/common-utils/pull/596)) (#[606](https://github.com/opensearch-project/common-utils/pull/606))
+
+### Documentation
+* Added 2.13.0.0 release notes ([#622](https://github.com/opensearch-project/common-utils/pull/622))

src/main/java/org/opensearch/commons/ConfigConstants.java

@@ -25,5 +25,7 @@ public class ConfigConstants {
     public static final String INJECTED_USER = "injected_user";
     public static final String OPENSEARCH_SECURITY_USE_INJECTED_USER_FOR_PLUGINS = "plugins.security_use_injected_user_for_plugins";
     public static final String OPENSEARCH_SECURITY_SSL_HTTP_ENABLED = "plugins.security.ssl.http.enabled";
+    public static final String OPENSEARCH_SECURITY_AUTHCZ_ADMIN_DN = "plugins.security.authcz.admin_dn";
     public static final String OPENSEARCH_SECURITY_USER_INFO_THREAD_CONTEXT = "_opendistro_security_user_info";
+
 }

src/main/java/org/opensearch/commons/authuser/User.java

@@ -10,6 +10,7 @@
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -18,8 +19,10 @@
 import org.opensearch.client.Response;
 import org.opensearch.common.Nullable;
 import org.opensearch.common.inject.internal.ToStringBuilder;
+import org.opensearch.common.settings.Settings;
 import org.opensearch.common.xcontent.XContentHelper;
 import org.opensearch.common.xcontent.json.JsonXContent;
+import org.opensearch.commons.ConfigConstants;
 import org.opensearch.core.common.Strings;
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
@@ -249,4 +252,12 @@ public List<String> getCustomAttNames() {
     public String getRequestedTenant() {
         return requestedTenant;
     }
+
+    public boolean isAdminDn(Settings settings) {
+        if (settings == null) {
+            return false;
+        }
+        List<String> adminDns = settings.getAsList(ConfigConstants.OPENSEARCH_SECURITY_AUTHCZ_ADMIN_DN, Collections.emptyList());
+        return adminDns.contains(this.name);
+    }
 }

src/main/java/org/opensearch/commons/rest/SecureRestClientBuilder.java

@@ -46,7 +46,7 @@
  *
  * Other usage:
  *  RestClient restClient = new SecureRestClientBuilder("localhost", 9200, false)
- *                     .setUserPassword("admin", "admin")
+ *                     .setUserPassword("admin", "myStrongPassword123")
  *                     .setTrustCerts(trustStorePath)
  *                     .build();
  *

src/main/kotlin/org/opensearch/commons/alerting/AlertingPluginInterface.kt

@@ -4,6 +4,7 @@
  */
 package org.opensearch.commons.alerting
 
+import org.opensearch.action.search.SearchResponse
 import org.opensearch.client.node.NodeClient
 import org.opensearch.commons.alerting.action.AcknowledgeAlertRequest
 import org.opensearch.commons.alerting.action.AcknowledgeAlertResponse
@@ -17,6 +18,8 @@ import org.opensearch.commons.alerting.action.GetAlertsRequest
 import org.opensearch.commons.alerting.action.GetAlertsResponse
 import org.opensearch.commons.alerting.action.GetFindingsRequest
 import org.opensearch.commons.alerting.action.GetFindingsResponse
+import org.opensearch.commons.alerting.action.GetMonitorRequest
+import org.opensearch.commons.alerting.action.GetMonitorResponse
 import org.opensearch.commons.alerting.action.GetWorkflowAlertsRequest
 import org.opensearch.commons.alerting.action.GetWorkflowAlertsResponse
 import org.opensearch.commons.alerting.action.GetWorkflowRequest
@@ -26,6 +29,7 @@ import org.opensearch.commons.alerting.action.IndexMonitorResponse
 import org.opensearch.commons.alerting.action.IndexWorkflowRequest
 import org.opensearch.commons.alerting.action.IndexWorkflowResponse
 import org.opensearch.commons.alerting.action.PublishFindingsRequest
+import org.opensearch.commons.alerting.action.SearchMonitorRequest
 import org.opensearch.commons.alerting.action.SubscribeFindingsResponse
 import org.opensearch.commons.notifications.action.BaseResponse
 import org.opensearch.commons.utils.recreateObject
@@ -288,6 +292,51 @@ object AlertingPluginInterface {
         )
     }
 
+    /**
+     * Get Monitor interface.
+     * @param client Node client for making transport action
+     * @param request The request object
+     * @param listener The listener for getting response
+     */
+    fun getMonitor(
+        client: NodeClient,
+        request: GetMonitorRequest,
+        listener: ActionListener<GetMonitorResponse>
+    ) {
+        client.execute(
+            AlertingActions.GET_MONITOR_ACTION_TYPE,
+            request,
+            wrapActionListener(listener) { response ->
+                recreateObject(response) {
+                    GetMonitorResponse(
+                        it
+                    )
+                }
+            }
+        )
+    }
+
+    /**
+     * Search Monitors interface.
+     * @param client Node client for making transport action
+     * @param request The request object
+     * @param listener The listener for getting response
+     */
+    fun searchMonitors(
+        client: NodeClient,
+        request: SearchMonitorRequest,
+        listener: ActionListener<SearchResponse>
+    ) {
+        client.execute(
+            AlertingActions.SEARCH_MONITORS_ACTION_TYPE,
+            request,
+            // we do not use the wrapActionListener in this case since there is no need
+            // to recreate any object or specially handle onResponse / onFailure. It is
+            // simply returning a SearchResponse.
+            listener
+        )
+    }
+
     @Suppress("UNCHECKED_CAST")
     private fun <Response : BaseResponse> wrapActionListener(
         listener: ActionListener<Response>,

src/main/kotlin/org/opensearch/commons/alerting/action/AcknowledgeChainedAlertRequest.kt

@@ -19,7 +19,7 @@ class AcknowledgeChainedAlertRequest : ActionRequest {
 
     constructor(
         workflowId: String,
-        alertIds: List<String>,
+        alertIds: List<String>
     ) : super() {
         this.workflowId = workflowId
         this.alertIds = alertIds
@@ -28,7 +28,7 @@ class AcknowledgeChainedAlertRequest : ActionRequest {
     @Throws(IOException::class)
     constructor(sin: StreamInput) : this(
         sin.readString(), // workflowId
-        Collections.unmodifiableList(sin.readStringList()), // alertIds
+        Collections.unmodifiableList(sin.readStringList()) // alertIds
     )
 
     override fun validate(): ActionRequestValidationException? {