diff --git a/client/LICENSE.txt b/client/LICENSE.txt new file mode 100644 index 00000000..3ab280eb --- /dev/null +++ b/client/LICENSE.txt @@ -0,0 +1,204 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. + +This project is based on a modification of https://github.com/uber/h3 which is licensed under the Apache 2.0 License. diff --git a/client/NOTICE.txt b/client/NOTICE.txt new file mode 100644 index 00000000..76223dfd --- /dev/null +++ b/client/NOTICE.txt @@ -0,0 +1,2 @@ +OpenSearch (https://opensearch.org) +Copyright OpenSearch Contributors \ No newline at end of file diff --git a/client/build.gradle b/client/build.gradle index bff7fe79..3760582a 100644 --- a/client/build.gradle +++ b/client/build.gradle @@ -3,16 +3,13 @@ * SPDX-License-Identifier: Apache-2.0 */ -apply plugin: 'java' -apply plugin: 'maven-publish' -apply plugin: 'jacoco' +//apply plugin: 'java' +apply plugin: 'opensearch.build' apply plugin: 'io.freefair.lombok' allprojects { group = opensearch_group version = "${opensearch_build}" - targetCompatibility = JavaVersion.VERSION_11 - sourceCompatibility = JavaVersion.VERSION_11 } repositories { @@ -33,15 +30,15 @@ compileTestJava { dependencies { compileOnly "${group}:opensearch:${opensearch_version}" - testImplementation 'org.junit.jupiter:junit-jupiter:5.11.3' - testImplementation 'org.junit.jupiter:junit-jupiter-api:5.11.3' - testImplementation 'org.mockito:mockito-core:5.14.2' - testImplementation 'org.mockito:mockito-junit-jupiter:5.14.2' - + testImplementation "junit:junit:${versions.junit}" + testImplementation "org.mockito:mockito-core:${versions.mockito}" testImplementation "${group}:opensearch:${opensearch_version}" } +licenseFile = "LICENSE.txt" +noticeFile = "NOTICE.txt" + publishing { publications { mavenJava(MavenPublication) { diff --git a/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentActionClientTest.java b/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentActionClientTest.java index 597dfcc9..feab90f3 100644 --- a/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentActionClientTest.java +++ b/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentActionClientTest.java @@ -6,11 +6,9 @@ package org.opensearch.geospatial.action; import lombok.SneakyThrows; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.Assert; +import org.junit.Test; import org.mockito.Mock; -import org.mockito.junit.jupiter.MockitoExtension; import org.opensearch.client.node.NodeClient; import org.opensearch.common.action.ActionFuture; import org.opensearch.core.action.ActionResponse; @@ -22,8 +20,8 @@ import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.when; -@ExtendWith(MockitoExtension.class) -class IpEnrichmentActionClientTest { + +public class IpEnrichmentActionClientTest { @Mock private NodeClient mockNodeClient; @@ -33,7 +31,7 @@ class IpEnrichmentActionClientTest { @SneakyThrows @Test - void testWithValidResponse() { + public void testWithValidResponse() { Map dummyPayload = Map.of("k1", "v1"); String dummyIpString = "192.168.1.1"; when(mockResult.get()).thenReturn(new IpEnrichmentResponse(dummyPayload)); @@ -41,17 +39,17 @@ void testWithValidResponse() { IpEnrichmentActionClient ipClient = new IpEnrichmentActionClient(mockNodeClient); Map actualPayload = ipClient.getGeoLocationData(dummyIpString); - Assertions.assertEquals(dummyPayload, actualPayload); + Assert.assertEquals(dummyPayload, actualPayload); } - @SneakyThrows @Test - void testWithException() { + @SneakyThrows + public void testWithException() { String dummyIpString = "192.168.1.1"; when(mockResult.get()).thenThrow(new ExecutionException(new Throwable())); when(mockNodeClient.execute(eq(IpEnrichmentAction.INSTANCE), any())).thenReturn(mockResult); IpEnrichmentActionClient ipClient = new IpEnrichmentActionClient(mockNodeClient); - Assertions.assertNull(ipClient.getGeoLocationData(dummyIpString)); + Assert.assertNull(ipClient.getGeoLocationData(dummyIpString)); } } \ No newline at end of file diff --git a/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentRequestTest.java b/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentRequestTest.java index 1b0b7b58..40c4158b 100644 --- a/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentRequestTest.java +++ b/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentRequestTest.java @@ -6,8 +6,8 @@ package org.opensearch.geospatial.action; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Test; +import org.junit.Assert; +import org.junit.Test; /** * Test cases for IpEnrichmentRequest. @@ -21,7 +21,7 @@ public class IpEnrichmentRequestTest { public void testValidateValidRequest() { IpEnrichmentRequest request = new IpEnrichmentRequest( "192.168.1.1", "ValidDataSourceName"); - Assertions.assertNull(request.validate()); + Assert.assertNull(request.validate()); } /** @@ -32,7 +32,7 @@ public void testValidateValidRequest() { public void testValidateNullDataSourceName() { IpEnrichmentRequest request = new IpEnrichmentRequest( "192.168.1.1", null); - Assertions.assertNull(request.validate()); + Assert.assertNull(request.validate()); } /** @@ -43,7 +43,7 @@ public void testValidateNullDataSourceName() { public void testValidateNullIpStringAndDataSourceName() { IpEnrichmentRequest request = new IpEnrichmentRequest( null, null); - Assertions.assertEquals(1, request.validate().validationErrors().size()); + Assert.assertEquals(1, request.validate().validationErrors().size()); } @@ -60,8 +60,8 @@ public void testFromActionRequestOnValidRecord() { IpEnrichmentRequest requestAfterStream = IpEnrichmentRequest.fromActionRequest(request); - Assertions.assertEquals(request.getIpString(), requestAfterStream.getIpString()); - Assertions.assertEquals(request.getDatasourceName(), requestAfterStream.getDatasourceName()); + Assert.assertEquals(request.getIpString(), requestAfterStream.getIpString()); + Assert.assertEquals(request.getDatasourceName(), requestAfterStream.getDatasourceName()); } } \ No newline at end of file diff --git a/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentResponseTest.java b/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentResponseTest.java index 83591104..a5f0cde1 100644 --- a/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentResponseTest.java +++ b/client/src/test/java/org/opensearch/geospatial/action/IpEnrichmentResponseTest.java @@ -5,22 +5,22 @@ package org.opensearch.geospatial.action; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Test; +import org.junit.Assert; +import org.junit.Test; import java.util.Map; -class IpEnrichmentResponseTest { +public class IpEnrichmentResponseTest { /** * To simulate when Response class being passed from one plugin to the other. */ @Test - void testFromActionResponseWithValidPayload() { + public void testFromActionResponseWithValidPayload() { Map payload = Map.of("k1", "v1"); IpEnrichmentResponse response = new IpEnrichmentResponse(payload); IpEnrichmentResponse castedResponse = IpEnrichmentResponse.fromActionResponse(response); - Assertions.assertEquals(response.getGeoLocationData(), castedResponse.getGeoLocationData()); + Assert.assertEquals(response.getGeoLocationData(), castedResponse.getGeoLocationData()); } } \ No newline at end of file