Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add saltssherror for better error reporting #292

Merged
merged 1 commit into from
Oct 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/main/java/com/suse/salt/netapi/calls/LocalCall.java
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,7 @@ private List<Map<String, Result<R>>> handleRetcodeBatchingHack(List<Map<String,
return Result.error(parsingError);
}
},
Result::error,
Result::error
);
}, Result::success);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ public String getFunctionName() {
public <T> T fold(Function<FunctionNotAvailable, ? extends T> fnNotAvail,
Function<ModuleNotSupported, ? extends T> modNotSupported,
Function<JsonParsingError, ? extends T> jsonError,
Function<GenericError, ? extends T> generic
Function<GenericError, ? extends T> generic,
Function<SaltSSHError, ? extends T> saltSSHError
) {
return fnNotAvail.apply(this);
}
Expand Down
4 changes: 3 additions & 1 deletion src/main/java/com/suse/salt/netapi/errors/GenericError.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ public int hashCode() {
public <T> T fold(Function<FunctionNotAvailable, ? extends T> fnNotAvail,
Function<ModuleNotSupported, ? extends T> modNotSupported,
Function<JsonParsingError, ? extends T> jsonError,
Function<GenericError, ? extends T> generic) {
Function<GenericError, ? extends T> generic,
Function<SaltSSHError, ? extends T> saltSSHError
) {
return generic.apply(this);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ public Throwable getThrowable() {
public <T> T fold(Function<FunctionNotAvailable, ? extends T> fnNotAvail,
Function<ModuleNotSupported, ? extends T> modNotSupported,
Function<JsonParsingError, ? extends T> jsonError,
Function<GenericError, ? extends T> generic
Function<GenericError, ? extends T> generic,
Function<SaltSSHError, ? extends T> saltSSHError
) {
return jsonError.apply(this);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ public String toString() {
public <T> T fold(Function<FunctionNotAvailable, ? extends T> fnNotAvail,
Function<ModuleNotSupported, ? extends T> modNotSupported,
Function<JsonParsingError, ? extends T> jsonError,
Function<GenericError, ? extends T> generic
Function<GenericError, ? extends T> generic,
Function<SaltSSHError, ? extends T> saltSSHError
) {
return modNotSupported.apply(this);
}
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/suse/salt/netapi/errors/SaltError.java
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ public interface SaltError {
<T> T fold(Function<FunctionNotAvailable, ? extends T> fnNotAvail,
Function<ModuleNotSupported, ? extends T> modNotSupported,
Function<JsonParsingError, ? extends T> jsonError,
Function<GenericError, ? extends T> generic);
Function<GenericError, ? extends T> generic,
Function<SaltSSHError, ? extends T> saltSSHError);

}

40 changes: 40 additions & 0 deletions src/main/java/com/suse/salt/netapi/errors/SaltSSHError.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package com.suse.salt.netapi.errors;

import java.util.function.Function;

/**
* Interface for salt ssh specific errors
*/
public class SaltSSHError implements SaltError {

private final int retcode;
private final String message;

public SaltSSHError(int retcode, String message) {
this.message = message;
this.retcode = retcode;
}

@Override
public String toString() {
return "SaltSSHError(" + getRetcode() + ", " + getMessage() + ")";
}

public int getRetcode() {
return retcode;
}

public String getMessage() {
return message;
}

public <T> T fold(Function<FunctionNotAvailable, ? extends T> fnNotAvail,
Function<ModuleNotSupported, ? extends T> modNotSupported,
Function<JsonParsingError, ? extends T> jsonError,
Function<GenericError, ? extends T> generic,
Function<SaltSSHError, ? extends T> saltSSHError) {
return saltSSHError.apply(this);
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,19 @@
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import com.suse.salt.netapi.errors.JsonParsingError;
import com.suse.salt.netapi.errors.SaltError;
import com.suse.salt.netapi.errors.SaltSSHError;
import com.suse.salt.netapi.results.Result;
import com.suse.salt.netapi.results.Return;
import com.suse.salt.netapi.results.SSHResult;
import com.suse.salt.netapi.utils.SaltErrorUtils;
import com.suse.salt.netapi.utils.Xor;

import java.io.IOException;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Optional;
import java.util.List;
import java.util.Map;

import static com.suse.salt.netapi.utils.ClientUtils.parameterizedType;

/**
* {@link TypeAdapterFactory} for creating type adapters for parsing wrapped
Expand Down Expand Up @@ -70,12 +73,24 @@ public Result<SSHResult<R>> read(JsonReader in) throws IOException {
throw new NullPointerException("No salt ssh return value," +
" return code: " + value.getRetcode());
}
return new Result<>(Xor.right(value));
return Result.success(value);
} catch (Throwable e) {
Optional<SaltError> saltError =
extractStdErr(json).flatMap(SaltErrorUtils::deriveError);
return new Result<>(Xor.left(
saltError.orElse(new JsonParsingError(json, e))));
Type sshResultType = parameterizedType(null, SSHResult.class, JsonElement.class);
TypeToken<Return<List<Map<String, Result<R>>>>> typeToken =
(TypeToken<Return<List<Map<String, Result<R>>>>>) TypeToken.get(sshResultType);
SSHResult<JsonElement> result = JsonParser.GSON.fromJson(json, typeToken.getType());
if (result.getRetcode() != 0) {
return Result.error(
result.getStderr()
.flatMap(SaltErrorUtils::deriveError)
.orElse(
new SaltSSHError(result.getRetcode(),
result.getStderr().orElse(""))
)
);
} else {
return Result.error(new JsonParsingError(json, e));
}
}
}

Expand All @@ -84,17 +99,6 @@ public void write(JsonWriter out, Result<SSHResult<R>> xor) throws IOException {
throw new JsonParseException("Writing Xor is not supported");
}

private Optional<String> extractStdErr(JsonElement json) {
if (json.isJsonObject() && json.getAsJsonObject().has("stderr") &&
json.getAsJsonObject().get("stderr").isJsonPrimitive() &&
json.getAsJsonObject().get("stderr")
.getAsJsonPrimitive().isString()) {
return Optional.of(json.getAsJsonObject().get("stderr")
.getAsJsonPrimitive().getAsString());
}

return Optional.empty();
}
};
}

Expand Down