exceptionfactory commented on code in PR #9372: URL: https://github.com/apache/nifi/pull/9372#discussion_r1795573137
########## nifi-extension-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/main/java/org/apache/nifi/lookup/maxmind/IPLookupService.java: ########## @@ -44,6 +44,7 @@ import org.apache.nifi.serialization.record.MapRecord; import org.apache.nifi.serialization.record.Record; import org.apache.nifi.util.StopWatch; +import org.jetbrains.annotations.NotNull; Review Comment: Use of the `NotNull` annotation should be removed to avoid unnecessary dependencies on the JetBrains annotations library. ########## nifi-extension-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/test/java/org/apache/nifi/lookup/maxmind/TestIPLookupService.java: ########## @@ -0,0 +1,205 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.nifi.lookup.maxmind; + +import com.maxmind.geoip2.DatabaseReader; +import org.apache.nifi.lookup.TestProcessor; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.jetbrains.annotations.NotNull; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import java.io.File; +import java.io.IOException; +import java.net.InetAddress; +import java.util.Collections; +import java.util.Optional; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.ArgumentMatchers.any; + +public class TestIPLookupService { + private TestRunner runner; + private IPLookupService testSubject; + + private DatabaseReader mockDatabaseReader; + + @BeforeEach + public void setUp() { + runner = TestRunners.newTestRunner(TestProcessor.class); + testSubject = new IPLookupService() { + @NotNull + @Override + DatabaseReader createDatabaseReader(File dbFile) throws IOException { + return mockDatabaseReader; + } + }; + + mockDatabaseReader = Mockito.mock(DatabaseReader.class); + } + + @Test + void testLookupDefaultNoResult() throws Exception { + // GIVEN + runner.addControllerService("testSubject", testSubject); + runner.setProperty(testSubject, IPLookupService.GEO_DATABASE_FILE, "src/test/resources/dummy.mmdb"); + runner.enableControllerService(testSubject); + runner.assertValid(testSubject); + + final IPLookupService lookupService = (IPLookupService) runner.getProcessContext() + .getControllerServiceLookup() + .getControllerService("testSubject"); + + Mockito.when(mockDatabaseReader.tryCity(any(InetAddress.class))).thenReturn(Optional.empty()); + + // WHEN + final Optional<Record> lookupResult = lookupService.lookup(Collections.singletonMap(IPLookupService.IP_KEY, "0.0.0.0")); + + // THEN + Mockito.verify(mockDatabaseReader).tryCity(any(InetAddress.class)); + + assertEquals(Optional.empty(), lookupResult); + } + + @Test + void testLookupCityNoResult() throws Exception { + // GIVEN + runner.addControllerService("testSubject", testSubject); + runner.setProperty(testSubject, IPLookupService.GEO_DATABASE_FILE, "src/test/resources/dummy.mmdb"); + runner.setProperty(testSubject, IPLookupService.LOOKUP_CITY, "true"); + runner.enableControllerService(testSubject); + runner.assertValid(testSubject); + + final IPLookupService lookupService = (IPLookupService) runner.getProcessContext() + .getControllerServiceLookup() + .getControllerService("testSubject"); + + Mockito.when(mockDatabaseReader.tryCity(any(InetAddress.class))).thenReturn(Optional.empty()); + + // WHEN + final Optional<Record> lookupResult = lookupService.lookup(Collections.singletonMap(IPLookupService.IP_KEY, "0.0.0.0")); + + // THEN + Mockito.verify(mockDatabaseReader).tryCity(any(InetAddress.class)); + + assertEquals(Optional.empty(), lookupResult); + } + + @Test + void testLookupISPNoResult() throws Exception { + // GIVEN + runner.addControllerService("testSubject", testSubject); + runner.setProperty(testSubject, IPLookupService.GEO_DATABASE_FILE, "src/test/resources/dummy.mmdb"); + runner.setProperty(testSubject, IPLookupService.LOOKUP_CITY, "false"); + runner.setProperty(testSubject, IPLookupService.LOOKUP_ISP, "true"); + runner.enableControllerService(testSubject); + runner.assertValid(testSubject); + + final IPLookupService lookupService = (IPLookupService) runner.getProcessContext() + .getControllerServiceLookup() + .getControllerService("testSubject"); + + Mockito.when(mockDatabaseReader.tryIsp(any(InetAddress.class))).thenReturn(Optional.empty()); + + // WHEN + final Optional<Record> lookupResult = lookupService.lookup(Collections.singletonMap(IPLookupService.IP_KEY, "0.0.0.0")); Review Comment: Recommend declaring a static string for `0.0.0.0` and reusing across tests. ########## nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/test/groovy/org/apache/nifi/lookup/maxmind/TestIPLookupService.java: ########## @@ -0,0 +1,205 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.nifi.lookup.maxmind; + +import com.maxmind.geoip2.DatabaseReader; +import org.apache.nifi.lookup.TestProcessor; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.jetbrains.annotations.NotNull; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import java.io.File; +import java.io.IOException; +import java.net.InetAddress; +import java.util.Collections; +import java.util.Optional; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.ArgumentMatchers.any; + +public class TestIPLookupService { + private TestRunner runner; + private IPLookupService testSubject; + + private DatabaseReader mockDatabaseReader; + + @BeforeEach + public void setUp() { + runner = TestRunners.newTestRunner(TestProcessor.class); + testSubject = new IPLookupService() { Review Comment: Recommend naming this `service` or `lookupService` to align with standard conventions instead of the generic `testSubject`. ########## nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/test/groovy/org/apache/nifi/lookup/maxmind/TestIPLookupService.java: ########## @@ -0,0 +1,205 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.nifi.lookup.maxmind; + +import com.maxmind.geoip2.DatabaseReader; +import org.apache.nifi.lookup.TestProcessor; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.jetbrains.annotations.NotNull; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import java.io.File; +import java.io.IOException; +import java.net.InetAddress; +import java.util.Collections; +import java.util.Optional; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.ArgumentMatchers.any; + +public class TestIPLookupService { + private TestRunner runner; + private IPLookupService testSubject; + + private DatabaseReader mockDatabaseReader; + + @BeforeEach + public void setUp() { + runner = TestRunners.newTestRunner(TestProcessor.class); + testSubject = new IPLookupService() { + @NotNull + @Override + DatabaseReader createDatabaseReader(File dbFile) throws IOException { + return mockDatabaseReader; + } + }; + + mockDatabaseReader = Mockito.mock(DatabaseReader.class); Review Comment: Recommend using static imports for `mock()` and other Mockito methods to avoid repetition. ```suggestion mockDatabaseReader = mock(DatabaseReader.class); ``` ########## nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/test/groovy/org/apache/nifi/lookup/maxmind/TestIPLookupService.java: ########## @@ -0,0 +1,205 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.nifi.lookup.maxmind; + +import com.maxmind.geoip2.DatabaseReader; +import org.apache.nifi.lookup.TestProcessor; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.jetbrains.annotations.NotNull; Review Comment: ```suggestion ``` ########## nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/test/groovy/org/apache/nifi/lookup/maxmind/TestIPLookupService.java: ########## @@ -0,0 +1,205 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ + +package org.apache.nifi.lookup.maxmind; + +import com.maxmind.geoip2.DatabaseReader; +import org.apache.nifi.lookup.TestProcessor; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.jetbrains.annotations.NotNull; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import java.io.File; +import java.io.IOException; +import java.net.InetAddress; +import java.util.Collections; +import java.util.Optional; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.ArgumentMatchers.any; + +public class TestIPLookupService { + private TestRunner runner; + private IPLookupService testSubject; + + private DatabaseReader mockDatabaseReader; + + @BeforeEach + public void setUp() { + runner = TestRunners.newTestRunner(TestProcessor.class); + testSubject = new IPLookupService() { + @NotNull + @Override + DatabaseReader createDatabaseReader(File dbFile) throws IOException { + return mockDatabaseReader; + } + }; + + mockDatabaseReader = Mockito.mock(DatabaseReader.class); + } + + @Test + void testLookupDefaultNoResult() throws Exception { + // GIVEN + runner.addControllerService("testSubject", testSubject); + runner.setProperty(testSubject, IPLookupService.GEO_DATABASE_FILE, "src/test/resources/dummy.mmdb"); Review Comment: Instead of checking in `dummy.mmdb` as an empty file, using the `@TempDir` annotation and writing out an empty file before all test methods would avoid the need to commit extra files. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
