Remote Diagnostics API #13
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| // 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.cloudstack.api.command.admin.diagnostics; | ||
|
|
||
| import com.cloud.exception.InsufficientCapacityException; | ||
| import com.cloud.exception.ResourceUnavailableException; | ||
| import com.cloud.user.Account; | ||
| import com.cloud.vm.VirtualMachine; | ||
| import org.apache.cloudstack.acl.RoleType; | ||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiArgValidator; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.ApiErrorCode; | ||
| import org.apache.cloudstack.api.BaseCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.response.ExecuteDiagnosticsResponse; | ||
| import org.apache.cloudstack.api.response.SystemVmResponse; | ||
| import org.apache.cloudstack.context.CallContext; | ||
| import org.apache.cloudstack.diagnostics.DiagnosticsService; | ||
| import org.apache.cloudstack.diagnostics.DiagnosticsType; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| import javax.inject.Inject; | ||
| import java.util.Map; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| @APICommand(name = ExecuteDiagnosticsCmd.APINAME, responseObject = ExecuteDiagnosticsResponse.class, entityType = {VirtualMachine.class}, | ||
| responseHasSensitiveInfo = false, | ||
| requestHasSensitiveInfo = false, | ||
| description = "Execute network-utility command (ping/arping/tracert) on system VMs remotely", | ||
| authorized = {RoleType.Admin}, | ||
| since = "4.12.0.0") | ||
| public class ExecuteDiagnosticsCmd extends BaseCmd { | ||
| private static final Logger LOGGER = Logger.getLogger(ExecuteDiagnosticsCmd.class); | ||
| public static final String APINAME = "executeDiagnostics"; | ||
|
|
||
| @Inject | ||
| private DiagnosticsService diagnosticsService; | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| //////////////// API parameters ///////////////////// | ||
| ///////////////////////////////////////////////////// | ||
| @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required = true, entityType = SystemVmResponse.class, | ||
| validations = {ApiArgValidator.PositiveNumber}, | ||
| description = "The ID of the system VM instance to diagnose") | ||
| private Long id; | ||
|
|
||
| @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, required = true, | ||
| validations = {ApiArgValidator.NotNullOrEmpty}, | ||
| description = "The IP/Domain address to test connection to") | ||
| private String address; | ||
|
|
||
| @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, required = true, | ||
| validations = {ApiArgValidator.NotNullOrEmpty}, | ||
| description = "The system VM diagnostics type valid options are: ping, traceroute, arping") | ||
| private String type; | ||
|
|
||
| @Parameter(name = ApiConstants.PARAMS, type = CommandType.STRING, | ||
| authorized = {RoleType.Admin}, | ||
| description = "Additional command line options that apply for each command") | ||
| private String optionalArguments; | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| /////////////////// Accessors /////////////////////// | ||
| ///////////////////////////////////////////////////// | ||
| public Long getId() { | ||
| return id; | ||
| } | ||
|
|
||
| public String getAddress() { | ||
| return address; | ||
| } | ||
|
|
||
| public DiagnosticsType getType() { | ||
| DiagnosticsType diagnosticsType = DiagnosticsType.getCommand(type); | ||
| if (diagnosticsType == null) { | ||
| throw new IllegalArgumentException(type + " Is not a valid diagnostics command type. "); | ||
| } | ||
| return diagnosticsType; | ||
| } | ||
|
|
||
| public String getOptionalArguments() { | ||
| final String EMPTY_STRING = ""; | ||
|
|
||
| if (optionalArguments == null || optionalArguments.isEmpty()) { | ||
|
Member
There was a problem hiding this comment. I do this a lot as well, but it's better to use CollectionUtils.isEmpty()
Author
There was a problem hiding this comment. There is not much difference in terms of performance, but adopted since it provides cleaner code |
||
| return EMPTY_STRING; | ||
|
There was a problem hiding this comment. Return "" is fine, than declare a variable and return that. |
||
| } | ||
| final String regex = "^[\\w\\-\\s]+$"; | ||
| final Pattern pattern = Pattern.compile(regex); | ||
| final boolean hasInvalidChar = pattern.matcher(optionalArguments).find(); | ||
| if (!hasInvalidChar) { | ||
|
There was a problem hiding this comment. Write +/- unit tests for this validation method. |
||
| throw new IllegalArgumentException("Optional parameters contain unwanted characters: " + optionalArguments); | ||
| } | ||
| return optionalArguments; | ||
| } | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| /////////////////// Implementation ////////////////// | ||
| ///////////////////////////////////////////////////// | ||
| @Override | ||
| public String getCommandName() { | ||
| return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX; | ||
| } | ||
|
|
||
| @Override | ||
| public long getEntityOwnerId() { | ||
| Account account = CallContext.current().getCallingAccount(); | ||
| if (account != null) { | ||
| return account.getId(); | ||
| } | ||
| return Account.ACCOUNT_ID_SYSTEM; | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException { | ||
| ExecuteDiagnosticsResponse response = new ExecuteDiagnosticsResponse(); | ||
| try { | ||
| final Map<String, String> answerMap = diagnosticsService.runDiagnosticsCommand(this); | ||
| if (answerMap != null || !answerMap.isEmpty()) { | ||
| response.setStdout(answerMap.get("STDOUT")); | ||
|
There was a problem hiding this comment. Change the |
||
| response.setStderr(answerMap.get("STDERR")); | ||
| response.setExitCode(answerMap.get("EXITCODE")); | ||
| response.setObjectName("diagnostics results"); | ||
| response.setResponseName(getCommandName()); | ||
| this.setResponseObject(response); | ||
| } | ||
| } catch (ServerApiException e) { | ||
| LOGGER.error("Exception occurred while executing remote diagnostics command: ", e); | ||
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage()); | ||
|
Member
There was a problem hiding this comment. and wrapping a server exception with only INTERNAL_ERROR as message doesn't add much value. |
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| // | ||
| // 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.cloudstack.api.response; | ||
|
|
||
| import com.cloud.serializer.Param; | ||
| import com.cloud.vm.VirtualMachine; | ||
| import com.google.gson.annotations.SerializedName; | ||
| import org.apache.cloudstack.api.BaseResponse; | ||
| import org.apache.cloudstack.api.EntityReference; | ||
|
|
||
| @EntityReference(value = VirtualMachine.class) | ||
| public class ExecuteDiagnosticsResponse extends BaseResponse { | ||
| @SerializedName("STDOUT") | ||
|
There was a problem hiding this comment. lowercase the api response keys to stdout, stderr, exitcode. There was a problem hiding this comment. Use api constant class for them, perhaps use the same keys in the class where the details map is created. |
||
| @Param(description = "the standard output from the command execution") | ||
| private String stdout; | ||
|
|
||
| @SerializedName("STDERR") | ||
| @Param(description = "the standard error output from the command execution") | ||
| private String stderr; | ||
|
|
||
| @SerializedName("EXITCODE") | ||
| @Param(description = "the command execution return code") | ||
| private String exitCode; | ||
|
|
||
| public String getStdout() { | ||
| return stdout; | ||
| } | ||
|
|
||
| public void setStdout(String stdout) { | ||
| this.stdout = stdout; | ||
| } | ||
|
|
||
| public String getStderr() { | ||
| return stderr; | ||
| } | ||
|
|
||
| public void setStderr(String stderr) { | ||
| this.stderr = stderr; | ||
| } | ||
|
|
||
| public String getExitCode() { | ||
| return exitCode; | ||
| } | ||
|
|
||
| public void setExitCode(String exitCode) { | ||
| this.exitCode = exitCode; | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // | ||
| // 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.cloudstack.diagnostics; | ||
|
|
||
| import com.cloud.exception.AgentUnavailableException; | ||
| import com.cloud.exception.InvalidParameterValueException; | ||
| import org.apache.cloudstack.api.command.admin.diagnostics.ExecuteDiagnosticsCmd; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| public interface DiagnosticsService { | ||
|
|
||
| Map<String, String> runDiagnosticsCommand(ExecuteDiagnosticsCmd cmd) throws AgentUnavailableException, InvalidParameterValueException; | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // | ||
| // 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.cloudstack.diagnostics; | ||
|
|
||
| public enum DiagnosticsType { | ||
| PING("ping"), TRACEROUTE("traceroute"), ARPING("arping"); | ||
|
|
||
| private String value; | ||
|
|
||
| DiagnosticsType(String value) { | ||
| this.value = value; | ||
| } | ||
|
|
||
| public String getValue() { | ||
| return value; | ||
| } | ||
|
|
||
| public static DiagnosticsType getCommand(String cmd) { | ||
| for (DiagnosticsType type : DiagnosticsType.values()) { | ||
| if (type.value.equalsIgnoreCase(cmd)) { | ||
| return type; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you consider renaming this to
runDiagnostics. Ignore if already discussed with Paul and others.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At this point, might be a bit late. It would require redoing and testing a lot of things i.e unit/marvin test cases etc.