gerlowskija commented on code in PR #1053: URL: https://github.com/apache/solr/pull/1053#discussion_r1006937868
########## solr/core/src/test/org/apache/solr/handler/admin/api/DeleteReplicaPropertyAPITest.java: ########## @@ -0,0 +1,116 @@ +/* + * 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.solr.handler.admin.api; + +import static org.apache.solr.cloud.api.collections.CollectionHandlingUtils.SHARD_UNIQUE; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyLong; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import io.opentracing.noop.NoopSpan; +import java.util.Map; +import java.util.Optional; +import org.apache.solr.SolrTestCaseJ4; +import org.apache.solr.cloud.OverseerSolrResponse; +import org.apache.solr.cloud.api.collections.DistributedCollectionConfigSetCommandRunner; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.cloud.ZkNodeProps; +import org.apache.solr.common.util.NamedList; +import org.apache.solr.core.CoreContainer; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.mockito.ArgumentCaptor; + +/** Unit tests for {@link DeleteReplicaPropertyAPI} */ +public class DeleteReplicaPropertyAPITest extends SolrTestCaseJ4 { + + private CoreContainer mockCoreContainer; + private DistributedCollectionConfigSetCommandRunner mockCommandRunner; + private SolrQueryRequest mockQueryRequest; + private SolrQueryResponse queryResponse; + private ArgumentCaptor<ZkNodeProps> messageCapturer; + + private DeleteReplicaPropertyAPI deleteReplicaPropApi; + + @BeforeClass + public static void ensureWorkingMockito() { + assumeWorkingMockito(); + } + + @Before + public void setUp() throws Exception { + super.setUp(); + + mockCoreContainer = mock(CoreContainer.class); + mockCommandRunner = mock(DistributedCollectionConfigSetCommandRunner.class); + when(mockCoreContainer.getDistributedCollectionCommandRunner()) + .thenReturn(Optional.of(mockCommandRunner)); + when(mockCommandRunner.runCollectionCommand(any(), any(), anyLong())) + .thenReturn(new OverseerSolrResponse(new NamedList<>())); + mockQueryRequest = mock(SolrQueryRequest.class); + when(mockQueryRequest.getSpan()).thenReturn(NoopSpan.INSTANCE); + queryResponse = new SolrQueryResponse(); + messageCapturer = ArgumentCaptor.forClass(ZkNodeProps.class); + + deleteReplicaPropApi = + new DeleteReplicaPropertyAPI(mockCoreContainer, mockQueryRequest, queryResponse); + } + + @Test + public void testReportsErrorWhenCalledInStandaloneMode() { + when(mockCoreContainer.isZooKeeperAware()).thenReturn(false); + + final SolrException e = + expectThrows( + SolrException.class, + () -> { + deleteReplicaPropApi.deleteReplicaProperty( + "someColl", "someShard", "someReplica", "somePropName"); + }); + assertEquals(400, e.code()); + assertTrue( + "Exception message differed from expected: " + e.getMessage(), + e.getMessage().contains("not running in SolrCloud mode")); + } + + @Test + public void testCreatesValidOverseerMessage() throws Exception { Review Comment: Tbh I'm at a bit of a loss as to how to proceed in testing this stuff. I want to address your concerns as best as I can, but I feel pretty strongly that we shouldn't be writing even more integration tests every time we modify a v2 API. And if I'm not misunderstanding you, that kindof sounds like what you're suggesting here. (i.e. "set the property and then get the property" requires (at a minimum) a ZK for the props to live in, if not a full Solr to submit the API to) **Why am I anti-integration test for these PRs?** Firstly, because it just wouldn't scale. If I add an integration test for each v2 API as I refactor it, we'll be near doubling the size of our test suite! (Or at least, something on that order of magnitude *general handwavy-ness*.) And then, down the road when individual SolrJ classes switch over to using v2, we'll have essentially duplicate tests everywhere! Secondly, because an integration test wouldn't add all that much coverage for the trouble - these refactor PRs change the v1 codepath to _use_ the v2 objects, so the existing v1 integration tests are already testing the v2 code, in a sense. There's a bit of a gap around validating that the v2 endpoint itself looks the way we want it to. A v2-specific integration test _would_ cover that, but there are lighter, quicker, less flaky ways to close that gap (e.g. a `JerseyTest`-based unit test). Lastly, I don't see messages as internal at all. In fact, I see them as external, almost by definition. They're sent/received/understood by multiple sub-systems, which makes them internal to none, right? Unless you consider even these interfaces between sub-components to be "internal"? Ultimately if you have this thing that one part of your system throws over the wall to another, it seems helpful to have some low-level automated validation that you don't accidentally steer from that contract. An integration test might catch that break, but it might not. That's one of the advantages of unit tests here - they can quickly cover more variations than is usually feasible to integration test. **So, What Now?** I'm really hoping there's common ground to address both our concerns. Lmk if you see some. I mentioned some potential alternatives in the second half of my comment [here](https://github.com/apache/solr/pull/1053#discussion_r1006192774), so hopefully one of those will work? I do really want to get this sorted out; not for the sake of this PR specifically but because this is just 1 of many similar PRs we'll need to get v2 into line, and I want to find something we can both live with in all those going forward. I'm going to bring all the non-test stuff in this PR up to date, so that when we find a compromise on the test stuff, we'll be ready to go. -- 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: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
