Skip to content

Commit

Permalink
GEODE-10084: CliFunction should handle all throwable (apache#7395)
Browse files Browse the repository at this point in the history
* Update ImportDataFunction to extend CliFunction
  • Loading branch information
jinmeiliao authored Feb 28, 2022
1 parent 040062d commit 41e7a17
Show file tree
Hide file tree
Showing 4 changed files with 163 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public final void execute(FunctionContext<T> context) {
context.getResultSender().lastResult(executeFunction(context));
} catch (EntityNotFoundException nfe) {
context.getResultSender().lastResult(new CliFunctionResult(context.getMemberName(), nfe));
} catch (Exception e) {
} catch (Throwable e) {
logger.error(e.getMessage(), e);
context.getResultSender().lastResult(new CliFunctionResult(context.getMemberName(), e));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import org.apache.geode.cache.snapshot.SnapshotOptions;
import org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat;
import org.apache.geode.internal.cache.InternalCache;
import org.apache.geode.internal.cache.execute.InternalFunction;
import org.apache.geode.management.cli.CliFunction;
import org.apache.geode.management.internal.functions.CliFunctionResult;
import org.apache.geode.management.internal.i18n.CliStrings;

Expand All @@ -32,7 +32,7 @@
* RegionSnapshotService to import the data
*
*/
public class ImportDataFunction implements InternalFunction<Object[]> {
public class ImportDataFunction extends CliFunction<Object[]> {
private static final long serialVersionUID = 1L;

private static final String ID =
Expand All @@ -44,7 +44,7 @@ public String getId() {
}

@Override
public void execute(FunctionContext<Object[]> context) {
public CliFunctionResult executeFunction(FunctionContext<Object[]> context) throws Exception {
final Object[] args = context.getArguments();
if (args.length < 4) {
throw new IllegalStateException(
Expand All @@ -56,32 +56,27 @@ public void execute(FunctionContext<Object[]> context) {
final boolean parallel = (boolean) args[3];

CliFunctionResult result;
try {
final Cache cache =
((InternalCache) context.getCache()).getCacheForProcessingClientRequests();
final Region<Object, Object> region = cache.getRegion(regionName);
final String hostName = cache.getDistributedSystem().getDistributedMember().getHost();
if (region != null) {
RegionSnapshotService<Object, Object> snapshotService = region.getSnapshotService();
SnapshotOptions<Object, Object> options = snapshotService.createOptions();
options.invokeCallbacks(invokeCallbacks);
options.setParallelMode(parallel);
File importFile = new File(importFileName);
snapshotService.load(new File(importFileName), SnapshotFormat.GEODE, options);
String successMessage = CliStrings.format(CliStrings.IMPORT_DATA__SUCCESS__MESSAGE,
importFile.getCanonicalPath(), hostName, regionName);
result = new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.OK,
successMessage);
} else {
result = new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR,
CliStrings.format(CliStrings.REGION_NOT_FOUND, regionName));
}

} catch (Exception e) {
final Cache cache =
((InternalCache) context.getCache()).getCacheForProcessingClientRequests();
final Region<Object, Object> region = cache.getRegion(regionName);
final String hostName = cache.getDistributedSystem().getDistributedMember().getHost();
if (region != null) {
RegionSnapshotService<Object, Object> snapshotService = region.getSnapshotService();
SnapshotOptions<Object, Object> options = snapshotService.createOptions();
options.invokeCallbacks(invokeCallbacks);
options.setParallelMode(parallel);
File importFile = new File(importFileName);
snapshotService.load(new File(importFileName), SnapshotFormat.GEODE, options);
String successMessage = CliStrings.format(CliStrings.IMPORT_DATA__SUCCESS__MESSAGE,
importFile.getCanonicalPath(), hostName, regionName);
result = new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.OK,
successMessage);
} else {
result = new CliFunctionResult(context.getMemberName(), CliFunctionResult.StatusState.ERROR,
e.getMessage());
CliStrings.format(CliStrings.REGION_NOT_FOUND, regionName));
}

context.getResultSender().lastResult(result);
return result;
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
*
* 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.geode.management.internal.cli.functions;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;

import org.apache.geode.InternalGemFireError;
import org.apache.geode.cache.execute.FunctionContext;
import org.apache.geode.cache.execute.ResultSender;
import org.apache.geode.management.cli.CliFunction;
import org.apache.geode.management.internal.functions.CliFunctionResult;

public class CliFunctionTest {

private FunctionContext<Object[]> context;
private ResultSender<Object> resultSender;

@SuppressWarnings("unchecked")
@Before
public void before() {
context = mock(FunctionContext.class);
resultSender = mock(ResultSender.class);
when(context.getResultSender()).thenReturn(resultSender);
}

@Test
public void executeShouldSendCliFunctionResultIfErrorHappens() throws Exception {
CliFunction<Object[]> function = new CliFunction<Object[]>() {
@Override
public CliFunctionResult executeFunction(FunctionContext<Object[]> context) {
throw new InternalGemFireError("test");
}
};
function.execute(context);

ArgumentCaptor<Object> captor = ArgumentCaptor.forClass(Object.class);
verify(resultSender).lastResult(captor.capture());
assertThat(captor.getValue()).isInstanceOf(CliFunctionResult.class);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
*
* 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.geode.management.internal.cli.functions;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;

import org.apache.geode.cache.execute.FunctionContext;
import org.apache.geode.cache.execute.ResultSender;
import org.apache.geode.management.cli.CliFunction;
import org.apache.geode.management.internal.functions.CliFunctionResult;

public class ImportDataFunctionTest {

private ImportDataFunction importer;
private FunctionContext<Object[]> context;
private ResultSender<Object> resultSender;

@SuppressWarnings("unchecked")
@Before
public void before() {
importer = new ImportDataFunction();
context = mock(FunctionContext.class);
resultSender = mock(ResultSender.class);
when(context.getResultSender()).thenReturn(resultSender);
}

@Test
public void importDataFunctionShouldSendCliFunctionResultIfExceptionHappens() {
assertThat(importer).isInstanceOf(CliFunction.class);
when(context.getArguments()).thenReturn(new Object[0]);
importer.execute(context);

ArgumentCaptor<Object> captor = ArgumentCaptor.forClass(Object.class);
verify(resultSender).lastResult(captor.capture());
Object value = captor.getValue();
assertThat(value).isInstanceOf(CliFunctionResult.class);
assertThat(((CliFunctionResult) value).getStatusMessage())
.contains("Arguments length does not match required length");
}

@Test
public void importDataFunctionShouldSendCliFunctionResultIfErrorHappens() {
Object[] arguments = new Object[4];
arguments[2] = true;
arguments[3] = true;
when(context.getArguments()).thenReturn(arguments);
when(context.getCache()).thenThrow(new Error("test error"));
importer.execute(context);

ArgumentCaptor<Object> captor = ArgumentCaptor.forClass(Object.class);
verify(resultSender).lastResult(captor.capture());
Object value = captor.getValue();
assertThat(value).isInstanceOf(CliFunctionResult.class);
assertThat(((CliFunctionResult) value).getStatusMessage()).contains("test error");
}
}

0 comments on commit 41e7a17

Please sign in to comment.