Skip to content

Commit 3c5d997

Browse files
authored
Added a new line linter (opensearch-project#2875)
* Added linter to add new line Signed-off-by: Owais Kazi <owaiskazi19@gmail.com> * Fixed new lines Signed-off-by: Owais Kazi <owaiskazi19@gmail.com> * Ignore empty files Signed-off-by: Owais Kazi <owaiskazi19@gmail.com> * Updated DEVELOPER GUIDE Signed-off-by: Owais Kazi <owaiskazi19@gmail.com> * Renamed workflow file Signed-off-by: Owais Kazi <owaiskazi19@gmail.com> * Fixed failing tests Signed-off-by: Owais Kazi <owaiskazi19@gmail.com>
1 parent 08e4a35 commit 3c5d997

File tree

154 files changed

+115
-167
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+115
-167
lines changed

.ci/dockerOnLinuxExclusions

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ ol-7.7
1212
sles-12.3 # older version used in Vagrant image
1313
sles-12.5
1414
sles-15.1
15-
sles-15.2
15+
sles-15.2

.github/workflows/code-hygiene.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Code Hygiene
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
linelint:
7+
runs-on: ubuntu-latest
8+
name: Check if all files end in newline
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v2
12+
13+
- name: Linelint
14+
uses: fernandrone/linelint@0.0.4

.github/workflows/delete_backport_branch.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ jobs:
1212
- name: Delete merged branch
1313
uses: SvanBoxel/delete-merged-branch@main
1414
env:
15-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/links.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ jobs:
1616
args: --accept=200,403,429 --exclude-mail **/*.html **/*.md **/*.txt **/*.json --exclude-file .lychee.excludes
1717
fail: true
1818
env:
19-
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
19+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/wrapper.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ jobs:
77
runs-on: ubuntu-latest
88
steps:
99
- uses: actions/checkout@v2
10-
- uses: gradle/wrapper-validation-action@v1
10+
- uses: gradle/wrapper-validation-action@v1

.linelint.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# 'true' will fix files
2+
autofix: true
3+
4+
ignore:
5+
- .git/
6+
- .gradle/
7+
- .idea/
8+
- '*.sha1'
9+
- '*.txt'
10+
- '.github/CODEOWNERS'
11+
- 'buildSrc/src/testKit/opensearch.build/LICENSE'
12+
- 'buildSrc/src/testKit/opensearch.build/NOTICE'
13+
- 'server/licenses/apache-log4j-extras-DEPENDENCIES'
14+
# Empty files
15+
- 'doc-tools/missing-doclet/bin/main/org/opensearch/missingdoclet/MissingDoclet.class'
16+
- 'buildSrc/src/integTest/resources/org/opensearch/gradle/internal/fake_git/remote/build.gradle'
17+
- 'buildSrc/src/integTest/resources/org/opensearch/gradle/internal/fake_git/remote/distribution/archives/oss-darwin-tar/build.gradle'
18+
- 'buildSrc/src/integTest/resources/org/opensearch/gradle/internal/fake_git/remote/distribution/bwc/bugfix/build.gradle'
19+
- 'buildSrc/src/integTest/resources/org/opensearch/gradle/internal/fake_git/remote/distribution/bwc/minor/build.gradle'
20+
- 'buildSrc/src/main/resources/buildSrc.marker'
21+
- 'buildSrc/src/testKit/opensearch-build-resources/settings.gradle'
22+
- 'buildSrc/src/testKit/opensearch.build/settings.gradle'
23+
- 'buildSrc/src/testKit/reaper/settings.gradle'
24+
- 'buildSrc/src/testKit/symbolic-link-preserving-tar/settings.gradle'
25+
- 'buildSrc/src/testKit/testingConventions/empty_test_task/.gitignore'
26+
- 'client/rest-high-level/src/main/resources/META-INF/services/org.opensearch.plugins.spi.NamedXContentProvider'
27+
- 'distribution/bwc/bugfix/build.gradle'
28+
- 'distribution/bwc/maintenance/build.gradle'
29+
- 'distribution/bwc/minor/build.gradle'
30+
- 'distribution/bwc/staged/build.gradle'
31+
- 'libs/ssl-config/src/test/resources/certs/pem-utils/empty.pem'
32+
- 'qa/evil-tests/src/test/resources/org/opensearch/common/logging/does_not_exist/nothing_to_see_here'
33+
- 'qa/os/centos-6/build.gradle'
34+
- 'qa/os/debian-8/build.gradle'
35+
- 'qa/os/oel-6/build.gradle'
36+
- 'qa/os/oel-7/build.gradle'
37+
- 'qa/os/sles-12/build.gradle'
38+
# Test requires no new line for these files
39+
- 'server/src/test/resources/org/opensearch/action/bulk/simple-bulk11.json'
40+
- 'server/src/test/resources/org/opensearch/action/search/simple-msearch5.json'
41+
42+
rules:
43+
# checks if file ends in a newline character
44+
end-of-file:
45+
# set to true to enable this rule
46+
enable: true
47+
48+
# if true also checks if file ends in a single newline character
49+
single-new-line: true

DEVELOPER_GUIDE.md

+16

README.md

+1-1

RELEASING.md

+1-1

SECURITY.md

+1-1

buildSrc/src/main/resources/eclipse.settings/org.eclipse.core.resources.prefs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ encoding//src/main/java=UTF-8
33
encoding//src/main/resources=UTF-8
44
encoding//src/test/java=UTF-8
55
encoding//src/test/resources=UTF-8
6-
encoding/<project>=UTF-8
6+
encoding/<project>=UTF-8
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.4.1
1+
7.4.1

buildSrc/src/testKit/testingConventions/build.gradle

-3
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,3 @@ project(':valid_setup_with_base') {
8888
}
8989
}
9090
}
91-
92-
93-

buildSrc/src/testKit/testingConventions/settings.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ include 'all_classes_in_tasks'
1616
include 'not_implementing_base'
1717
include 'valid_setup_no_base'
1818
include 'valid_setup_with_base'
19-
include 'tests_in_main'
19+
include 'tests_in_main'

buildSrc/src/testKit/thirdPartyAudit/settings.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
* GitHub history for details.
1010
*/
1111

12-
include 'sample_jars'
12+
include 'sample_jars'

dev-tools/prepare_release_update_documentation.py

-1
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,3 @@ def callback(line):
136136
print('WARNING: no documentation references updates for release %s' % (release_version))
137137

138138
print('*** Done.')
139-

dev-tools/signoff-check.sh

-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,3 @@ done
2828

2929
# Return non-zero error code if any commits were missing signoff
3030
exit $missingSignoff
31-

distribution/docker/src/test/resources/rest-api-spec/test/10_info.yml

-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@
77
- is_true: version
88
- is_true: version.number
99
- match: { version.build_type: "docker" }
10-

distribution/docker/src/test/resources/rest-api-spec/test/11_nodes.yml

-1
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,3 @@
123123
- match:
124124
$body: |
125125
/^(\S{5,}\n)+$/
126-

distribution/src/bin/opensearch-env-from-file

-1
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,3 @@ for VAR_NAME_FILE in OPENSEARCH_PASSWORD_FILE KEYSTORE_PASSWORD_FILE ; do
4747
unset "$VAR_NAME_FILE"
4848
fi
4949
done
50-

distribution/src/bin/opensearch-env.bat

-1
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,3 @@ if defined JAVA_OPTS (
7474

7575
rem check the Java version
7676
%JAVA% -cp "%OPENSEARCH_CLASSPATH%" "org.opensearch.tools.java_version_checker.JavaVersionChecker" || exit /b 1
77-

doc-tools/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@ version '1.0.0-SNAPSHOT'
88
repositories {
99
mavenCentral()
1010
}
11-

libs/dissect/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,3 @@ dependencies {
4040
tasks.named('forbiddenApisMain').configure {
4141
replaceSignatureFiles 'jdk-signatures'
4242
}
43-

libs/dissect/src/test/resources/specification/tests.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -360,4 +360,4 @@
360360
"append": ""
361361
}
362362

363-
]
363+
]

libs/geo/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,3 @@ tasks.named('forbiddenApisMain').configure {
4242
// TODO: Need to decide how we want to handle for forbidden signatures with the changes to core
4343
replaceSignatureFiles 'jdk-signatures'
4444
}
45-

libs/grok/src/main/resources/patterns/exim

-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,3 @@ EXIM_PROTOCOL (P=%{NOTSPACE:protocol})
1010
EXIM_MSG_SIZE (S=%{NUMBER:exim_msg_size})
1111
EXIM_HEADER_ID (id=%{NOTSPACE:exim_header_id})
1212
EXIM_SUBJECT (T=%{QS:exim_subject})
13-

libs/grok/src/main/resources/patterns/junos

-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,3 @@ RT_FLOW1 %{RT_FLOW_EVENT:event}: %{GREEDYDATA:close-reason}: %{IP:src-ip}/%{INT:
66
RT_FLOW2 %{RT_FLOW_EVENT:event}: session created %{IP:src-ip}/%{INT:src-port}->%{IP:dst-ip}/%{INT:dst-port} %{DATA:service} %{IP:nat-src-ip}/%{INT:nat-src-port}->%{IP:nat-dst-ip}/%{INT:nat-dst-port} %{DATA:src-nat-rule-name} %{DATA:dst-nat-rule-name} %{INT:protocol-id} %{DATA:policy-name} %{DATA:from-zone} %{DATA:to-zone} %{INT:session-id} .*
77

88
RT_FLOW3 %{RT_FLOW_EVENT:event}: session denied %{IP:src-ip}/%{INT:src-port}->%{IP:dst-ip}/%{INT:dst-port} %{DATA:service} %{INT:protocol-id}\(\d\) %{DATA:policy-name} %{DATA:from-zone} %{DATA:to-zone} .*
9-
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
# Default postgresql pg_log format pattern
22
POSTGRESQL %{DATESTAMP:timestamp} %{TZ} %{DATA:user_id} %{GREEDYDATA:connection_id} %{POSINT:pid}
3-

libs/ssl-config/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,3 @@ tasks.test {
6161
jvmArgs += ["--add-opens", "java.base/java.security.cert=ALL-UNNAMED"]
6262
}
6363
}
64-

modules/analysis-common/src/test/resources/org/opensearch/analysis/common/cjk_analysis.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@
3434
}
3535
}
3636
}
37-
}
37+
}

modules/analysis-common/src/test/resources/org/opensearch/analysis/common/pattern_capture.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@
4343
}
4444
}
4545
}
46-
}
46+
}

modules/analysis-common/src/yamlRestTest/resources/rest-api-spec/test/analysis-common/60_analysis_scripting.yml

-1
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,3 @@
6868
- match: { tokens.1.token: "f" }
6969
- match: { tokens.2.token: "g" }
7070
- match: { tokens.3.token: "h" }
71-

modules/analysis-common/src/yamlRestTest/resources/rest-api-spec/test/cluster.stats/10_analysis_stats.yml

-1
Original file line numberDiff line numberDiff line change
@@ -119,4 +119,3 @@
119119
- match: { indices.analysis.built_in_analyzers.2.name: spanish }
120120
- match: { indices.analysis.built_in_analyzers.2.count: 2 }
121121
- match: { indices.analysis.built_in_analyzers.2.index_count: 2 }
122-

modules/analysis-common/src/yamlRestTest/resources/rest-api-spec/test/indices.analyze/10_synonyms.yml

-1
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,3 @@
7676
- match: { tokens.5.token: dude }
7777
- match: { tokens.5.position: 4 }
7878
- match: { tokens.5.positionLength: null }
79-

modules/analysis-common/src/yamlRestTest/resources/rest-api-spec/test/search.query/60_synonym_graph.yml

-1
Original file line numberDiff line numberDiff line change
@@ -229,4 +229,3 @@ setup:
229229
query: bar baz
230230
analyzer: lower_graph_syns
231231
- match: { hits.total: 1 }
232-

modules/analysis-common/src/yamlRestTest/resources/rest-api-spec/test/search.query/70_intervals.yml

-1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,3 @@ setup:
5656
use_field: text_en
5757
max_gaps: 1
5858
- match: { hits.total.value: 1 }
59-

modules/ingest-common/src/yamlRestTest/resources/rest-api-spec/test/ingest/220_drop_processor.yml

-1
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,3 @@ teardown:
9191
get:
9292
index: test
9393
id: 3
94-

modules/ingest-user-agent/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,3 @@ restResources {
4343
testClusters.all {
4444
extraConfigFile 'ingest-user-agent/test-regexes.yml', file('src/test/test-regexes.yml')
4545
}
46-
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
user_agent_parsers:
22
- regex: '.*'
3-
family_replacement: 'Test'
3+
family_replacement: 'Test'

modules/lang-expression/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,3 @@ tasks.named("dependencyLicenses").configure {
5252
mapping from: /lucene-.*/, to: 'lucene'
5353
mapping from: /asm-.*/, to: 'asm'
5454
}
55-

modules/lang-painless/src/main/antlr/PainlessLexer.g4

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ ID: [_a-zA-Z] [_a-zA-Z0-9]*;
124124
mode AFTER_DOT;
125125

126126
DOTINTEGER: ( '0' | [1-9] [0-9]* ) -> mode(DEFAULT_MODE);
127-
DOTID: [_a-zA-Z] [_a-zA-Z0-9]* -> mode(DEFAULT_MODE);
127+
DOTID: [_a-zA-Z] [_a-zA-Z0-9]* -> mode(DEFAULT_MODE);

modules/lang-painless/src/yamlRestTest/resources/rest-api-spec/test/painless/100_terms_agg.yml

-1
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,3 @@ setup:
139139
- is_false: aggregations.placeholder.buckets.0.str_terms.buckets.1.key_as_string
140140
- match: { aggregations.placeholder.buckets.0.str_terms.buckets.1.doc_count: 1 }
141141
- match: { aggregations.placeholder.buckets.0.the_bucket_script.value: 2.0 }
142-

modules/opensearch-dashboards/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,3 @@ dependencies {
4141
testClusters.all {
4242
module ':modules:reindex'
4343
}
44-

modules/repository-url/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,3 @@ testClusters.all {
7575
"http://snapshot.test*,http://${urlFixture.addressAndPort}"
7676
}, PropertyNormalization.IGNORE_VALUE
7777
}
78-

modules/systemd/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,3 @@ opensearchplugin {
3232
description 'Integrates OpenSearch with systemd'
3333
classname 'org.opensearch.systemd.SystemdPlugin'
3434
}
35-

plugins/analysis-icu/src/test/resources/org/opensearch/index/analysis/KeywordTokenizer.rbbi

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818

1919
# Apply rule status {200}=RBBI.WORD_LETTER, which is mapped
2020
# to <ALPHANUM> token type by DefaultICUTokenizerConfig.
21-
.+ {200};
21+
.+ {200};

plugins/analysis-kuromoji/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,3 @@ restResources {
4646
tasks.named("dependencyLicenses").configure {
4747
mapping from: /lucene-.*/, to: 'lucene'
4848
}
49-

plugins/analysis-phonetic/src/yamlRestTest/resources/rest-api-spec/test/analysis_phonetic/10_metaphone.yml

-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,3 @@
3131
- match: { tokens.1.token: joe }
3232
- match: { tokens.2.token: BLKS }
3333
- match: { tokens.3.token: bloggs }
34-

plugins/analysis-phonetic/src/yamlRestTest/resources/rest-api-spec/test/analysis_phonetic/20_double_metaphone.yml

-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,3 @@
2828

2929
- length: { tokens: 1 }
3030
- match: { tokens.0.token: SPRKLF }
31-

plugins/analysis-phonetic/src/yamlRestTest/resources/rest-api-spec/test/analysis_phonetic/30_beider_morse.yml

-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,3 @@
3030

3131
- length: { tokens: 1 }
3232
- match: { tokens.0.token: Svarts }
33-

plugins/analysis-phonetic/src/yamlRestTest/resources/rest-api-spec/test/analysis_phonetic/50_daitch_mokotoff.yml

-1
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,3 @@
2727

2828
- length: { tokens: 1 }
2929
- match: { tokens.0.token: "645740" }
30-

plugins/analysis-smartcn/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,3 @@ restResources {
4747
tasks.named("dependencyLicenses").configure {
4848
mapping from: /lucene-.*/, to: 'lucene'
4949
}
50-
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
europe-west1-b
1+
europe-west1-b
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
metadataserver
1+
metadataserver

plugins/examples/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,3 @@ configure(project('painless-whitelist')) {
3636
}
3737
}
3838
}
39-

plugins/examples/custom-settings/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,3 @@ testClusters.all {
4242
// Adds a setting in the OpenSearch keystore before running the integration tests
4343
keystore 'custom.secured', 'password'
4444
}
45-

plugins/examples/custom-settings/src/main/config/custom.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
custom:
33
simple: foo
44
list: [0, 1, 1, 2, 3, 5, 8, 13, 21]
5-
filtered: secret
5+
filtered: secret

plugins/examples/rest-handler/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,3 @@ javaRestTest {
5656
dependsOn exampleFixture
5757
nonInputProperties.systemProperty 'external.address', "${-> exampleFixture.addressAndPort}"
5858
}
59-

0 commit comments

Comments
 (0)