Add new code hygiene workflow (#1699)

New workflow for running linters / checks to make sure the code base
continues to follow best practices.

Adding a new-line linter to make sure all files end with a single
newline.  This is a POSIX standard, read more https://stackoverflow.com/questions/729692/why-should-text-files-end-with-a-newline

Signed-off-by: Peter Nied <petern@amazon.com>

Author: peternied

.github/ISSUE_TEMPLATE/bug_template.md

@@ -0,0 +1,14 @@
+name: Code Hygiene
+
+on: [push, pull_request]
+
+jobs:
+  linelint:
+    runs-on: ubuntu-latest
+    name: Check if all files end in newline
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Linelint
+        uses: fernandrone/linelint@0.0.4

.github/ISSUE_TEMPLATE/feature_request.md

@@ -12,4 +12,4 @@ jobs:
       - name: Delete merged branch
         uses: SvanBoxel/delete-merged-branch@b77e873cee00b09f55cc553bd24aae5f8dfc9157
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/pull_request_template.md

@@ -41,4 +41,4 @@ IML
 # gradle
 build/
 gradle-build/
-.gradle/
+.gradle/

.github/workflows/code-hygiene.yml

@@ -0,0 +1,17 @@
+# 'true' will fix files
+autofix: true
+
+# list of paths to ignore, uses gitignore syntaxes (executes before any rule)
+ignore:
+  - .git/
+  - .gradle/
+  - src/test/resources/restapi/users_key_not_quoted.json
+
+rules:
+  # checks if file ends in a newline character
+  end-of-file:
+    # set to true to enable this rule
+    enable: true
+
+    # if true also checks if file ends in a single newline character
+    single-new-line: true

.github/workflows/delete_backport_branch.yml

@@ -12,4 +12,4 @@
   "issueSettings": {
     "minSeverityLevel": "LOW"
   }
-}
+}

.gitignore

@@ -386,4 +386,4 @@ buildRpm {
 buildDeb {
     arch = 'all'
     archiveName "${packageName}-${version}.deb"
-}
+}

.linelint.yml

@@ -183,4 +183,4 @@
 
   </module>
 
-</module>
+</module>

.whitesource

@@ -216,4 +216,4 @@ opendistro_security:
         transport_enabled: false
         authorization_backend:
           type: ldap #
-          #config goes here ...
+          #config goes here ...

ADMINS.md

@@ -42,4 +42,4 @@ readall:
 snapshotrestore:
   hash: $2y$12$DpwmetHKwgYnorbgdvORCenv4NAK8cPUg8AI6pxLCuWf/ALc0.v7W
   roles:
-    - snapshotrestore
+    - snapshotrestore

CONTRIBUTING.md

@@ -31,4 +31,4 @@ opendistro_security_manage_snapshots:
 
 opendistro_security_own_index:
   users:
-    - '*'
+    - '*'

DEVELOPER_GUIDE.md

@@ -79,4 +79,4 @@ grant {
 
 grant codeBase "${codebase.netty-common}" {
   permission java.lang.RuntimePermission "loadLibrary.*";
-};
+};

MAINTAINERS.md

@@ -1,3 +1,3 @@
 _meta:
   type: "actiongroups"
-  config_version: 2
+  config_version: 2

README.md

@@ -244,4 +244,4 @@ config:
   #        time_window_seconds: 3600
   #        block_expiry_seconds: 600
   #        max_blocked_clients: 100000
-  #        max_tracked_clients: 100000
+  #        max_tracked_clients: 100000

RELEASING.md

@@ -53,4 +53,4 @@ snapshotrestore:
   reserved: false
   backend_roles:
   - "snapshotrestore"
-  description: "Demo snapshotrestore user"
+  description: "Demo snapshotrestore user"

SECURITY.md

@@ -47,4 +47,3 @@
         </fileSet>
     </fileSets>
 </assembly>
-

build.gradle

@@ -40,4 +40,4 @@
       </excludes>
     </dependencySet>
   </dependencySets>
-</assembly>
+</assembly>

config/checkstyle/sun_checks.xml

@@ -32,4 +32,4 @@ public void setJwksUri(String jwksUri) {
 		this.jwksUri = jwksUri;
 	}
 
-}
+}

legacy/securityconfig_v6/config.yml

@@ -421,4 +421,4 @@ private static enum HttpMethod {
 	}
 
 
-}
+}

legacy/securityconfig_v6/internal_users.yml

@@ -73,4 +73,4 @@ public String toString() {
     public int compareTo(final AuthDomain o) {
         return Integer.compare(this.order, o.order);
     }
-}
+}

legacy/securityconfig_v6/roles_mapping.yml

@@ -24,4 +24,3 @@
 public interface AuthFailureListener {
     void onAuthFailure(InetAddress remoteAddress, AuthCredentials authCredentials, Object request);
 }
-

plugin-security.policy

@@ -168,4 +168,4 @@ public void onInternalUsersModelChanged(InternalUsersModel ium) {
     }
 
 
-}
+}

release-notes/opendistro-for-elasticsearch-security.release-notes-1.11.0.0.md

@@ -595,4 +595,3 @@ static Mode get(Settings settings) {
         }
     }
 }
-

release-notes/opendistro-for-elasticsearch-security.release-notes-1.7.0.0.md

@@ -162,4 +162,3 @@ boolean containsTermLookupQuery(String query)  {
 
 
 }
-

release-notes/opensearch-security.release-notes-1.0.0.0-beta1.md

@@ -152,4 +152,4 @@ protected void consumeParameters(final RestRequest request) {
         request.paramAsBoolean("accept_invalid", false);
     }
 
-}
+}

release-notes/opensearch-security.release-notes-1.2.0.0.md

@@ -44,4 +44,4 @@ public TenantValidator(final RestRequest request, boolean isSuperAdmin, BytesRef
         if (isSuperAdmin) allowedKeys.put("reserved", DataType.BOOLEAN);
     }
 
-}
+}

release-notes/opensearch-security.release-notes-1.2.1.0.md

@@ -99,4 +99,4 @@ public static enum PrivilegesEvaluatorResponseState {
         COMPLETE;
     }
 
-}
+}

release-notes/opensearch-security.release-notes-1.2.3.0.md

@@ -45,4 +45,4 @@ public abstract class ConfigModel {
     public abstract SecurityRoles getSecurityRoles();
 
     public abstract Set<String> getAllConfiguredTenantNames();
-}
+}

release-notes/opensearch-security.release-notes-1.2.4.0.md

@@ -36,4 +36,3 @@ public String getRequestMethod() {
         return requestMethod;
     }
 }
-

securityconfig/action_groups.yml

@@ -75,4 +75,4 @@ public String toString() {
     }
 
 
-}
+}

securityconfig/config.yml

@@ -319,4 +319,4 @@ public String toString() {
 
     }
 
-}
+}

securityconfig/internal_users.yml

@@ -91,4 +91,4 @@ public boolean isReserved() {
         return readonly;
     }
 
-}
+}

src/main/assemblies/plugin.xml

@@ -141,4 +141,4 @@ public boolean isReserved() {
         return readonly;
     }
 
-}
+}

src/main/assemblies/securityadmin-standalone.xml

@@ -116,4 +116,4 @@ public String toString() {
 
 
 
-}
+}

src/main/java/com/amazon/dlic/auth/http/jwt/oidc/json/OpenIdProviderConfiguration.java

@@ -460,4 +460,4 @@ public String toString() {
 
     }
 
-}
+}

src/main/java/org/opensearch/security/auditlog/sink/WebhookSink.java

@@ -155,4 +155,4 @@ public void setStatic(boolean _static) {
         }
 
 
-    }
+    }

src/main/java/org/opensearch/security/auth/AuthDomain.java

@@ -130,4 +130,4 @@ public String toString() {
 
 
 
-}
+}

src/main/java/org/opensearch/security/auth/AuthFailureListener.java

@@ -275,4 +275,4 @@ public String toString() {
 
 
 
-}
+}

src/main/java/org/opensearch/security/auth/internal/InternalAuthenticationBackend.java

@@ -77,4 +77,4 @@ public String toString() {
     }
 
 
-}
+}

src/main/java/org/opensearch/security/configuration/DlsFlsValveImpl.java

@@ -385,4 +385,3 @@ public static char[] randomChars(int len) {
 
     private PemKeyReader() { }
 }
-