ExternalVendorCode/onefuzz
1
0
Fork 0
mirror of https://github.com/microsoft/onefuzz.git synced 2025-06-18 20:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Standardize HTTP error results, better rejection message when parsing validated strings (#2663)

Browse Source 
1. When parsing a `ValidatedString` from JSON and it fails, include a message about the expected format of the string.
   - Reworked the classes using C#11 features to reduce the amount of boilerplate needed to add a new validated string type.

2. Change to use [RFC7807](https://www.rfc-editor.org/rfc/rfc7807) format for HTTP error responses. At the moment we returned the `Error` type which was undocumented.
3. Update CLI to parse RFC7807 responses.

Old error looked like:

```console
$ onefuzz containers create AbCd
ERROR:cli:command failed: request did not succeed: HTTP 500 -
```

New error looks like:

```console
$ onefuzz containers create AbCd
ERROR:cli:command failed: request did not succeed (400: INVALID_REQUEST): Unable
to parse 'AbCd' as a Container: Container name must be 3-63 lowercase letters, numbers,
or non-consecutive hyphens (see: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage)
```

Closes #2661.
This commit is contained in:
George Pollard
2022-12-02 10:33:14 +13:00
committed by GitHub
parent 88e8c11a02
commit 38dfa668bc
28 changed files with 304 additions and 294 deletions
Download Patch File Download Diff File Expand all files Collapse all files

192
src/ApiService/ApiService/OneFuzzTypes/Validated.cs
View File

@ -1,5 +1,4 @@
using System.Diagnostics; using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.CodeAnalysis;
using System.Text.Json; using System.Text.Json;
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
@ -7,44 +6,73 @@ using Azure.Core;
namespace Microsoft.OneFuzz.Service; namespace Microsoft.OneFuzz.Service;
static class Check { static partial class Check {
private static readonly Regex _isAlnum = new(@"\A[a-zA-Z0-9]+\z", RegexOptions.Compiled); [GeneratedRegex("\\A[a-zA-Z0-9]+\\z")]
public static bool IsAlnum(string input) => _isAlnum.IsMatch(input); private static partial Regex IsAlnumRegex();
public static bool IsAlnum(string input) => IsAlnumRegex().IsMatch(input);
private static readonly Regex _isAlnumDash = new(@"\A[a-zA-Z0-9\-]+\z", RegexOptions.Compiled); [GeneratedRegex("\\A[a-zA-Z0-9\\-]+\\z")]
public static bool IsAlnumDash(string input) => _isAlnumDash.IsMatch(input); private static partial Regex IsAlnumDashRegex();
public static bool IsAlnumDash(string input) => IsAlnumDashRegex().IsMatch(input);
// Permits 1-64 characters: alphanumeric, underscore, period, or dash. // Permits 1-64 characters: alphanumeric, underscore, period, or dash.
private static readonly Regex _isNameLike = new(@"\A[._a-zA-Z0-9\-]{1,64}\z", RegexOptions.Compiled); [GeneratedRegex("\\A[._a-zA-Z0-9\\-]{1,64}\\z")]
public static bool IsNameLike(string input) => _isNameLike.IsMatch(input); private static partial Regex IsNameLikeRegex();
public static bool IsNameLike(string input) => IsNameLikeRegex().IsMatch(input);
// This regex is based upon DNS labels but more restricted.
// It is used for many different Storage resources.
// See: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage
// - 3-63
// - Lowercase letters, numbers, and hyphens.
// - Start with lowercase letter or number. Can't use consecutive hyphens.
[GeneratedRegex(@"\A(?!-)(?!.*--)[a-z0-9\-]{3,63}\z")]
private static partial Regex StorageDnsLabelRegex();
public static bool IsStorageDnsLabel(string input) => StorageDnsLabelRegex().IsMatch(input);
} }
// Base class for types that are wrappers around a validated string. public interface IValidatedString<T> where T : IValidatedString<T> {
public abstract record ValidatedString(string String) { public static abstract T Parse(string input);
public static abstract bool IsValid(string input);
public static abstract string Requirements { get; }
public string String { get; }
}
public abstract record ValidatedStringBase<T> where T : IValidatedString<T> {
protected ValidatedStringBase(string value) {
if (!T.IsValid(value)) {
throw new ArgumentException(T.Requirements);
}
String = value;
}
public string String { get; }
public sealed override string ToString() => String; public sealed override string ToString() => String;
public static bool TryParse(string input, [NotNullWhen(returnValue: true)] out T? result) {
try {
result = T.Parse(input);
return true;
} catch (ArgumentException) {
result = default;
return false;
}
}
} }
// JSON converter for types that are wrappers around a validated string. // JSON converter for types that are wrappers around a validated string.
public abstract class ValidatedStringConverter<T> : JsonConverter<T> where T : ValidatedString { public sealed class ValidatedStringConverter<T> : JsonConverter<T> where T : IValidatedString<T> {
protected abstract bool TryParse(string input, out T? output);
public sealed override bool CanConvert(Type typeToConvert)
=> typeToConvert == typeof(T);
public sealed override T? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { public sealed override T? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) {
if (reader.TokenType != JsonTokenType.String) {
throw new JsonException("expected a string");
}
var value = reader.GetString(); var value = reader.GetString();
if (value is null) { if (value is null) {
throw new JsonException("expected a string"); throw new JsonException("Expected a string");
} }
if (TryParse(value, out var result)) { if (ValidatedStringBase<T>.TryParse(value, out var result)) {
return result; return result;
} else { } else {
throw new JsonException($"unable to parse input as a {typeof(T).Name}"); throw new JsonException($"Unable to parse '{value}' as a {typeof(T).Name}: {T.Requirements}");
} }
} }
@ -52,110 +80,32 @@ public abstract class ValidatedStringConverter<T> : JsonConverter<T> where T : V
=> writer.WriteStringValue(value.String); => writer.WriteStringValue(value.String);
} }
[JsonConverter(typeof(Converter))] [JsonConverter(typeof(ValidatedStringConverter<PoolName>))]
public sealed record PoolName : ValidatedString { public sealed record PoolName : ValidatedStringBase<PoolName>, IValidatedString<PoolName> {
private PoolName(string value) : base(value) { }
public static PoolName Parse(string input) => new(input);
public static string Requirements => "Pool name must have only numbers, letters, underscores, periods, or dashes";
// NOTE: PoolName is currently _not_ validated, since this // NOTE: PoolName is currently _not_ validated, since this
// can break existing users. When CSHARP-RELEASE happens, we can // can break existing users. When CSHARP-RELEASE happens, we can
// try to synchronize other breaking changes with that. // try to synchronize other breaking changes with that.
private static bool IsValid(string input) => true; public static bool IsValid(string input) => true;
private PoolName(string value) : base(value) {
Debug.Assert(IsValid(value));
}
public static PoolName Parse(string input) {
if (TryParse(input, out var result)) {
return result;
}
throw new ArgumentException("Pool name must have only numbers, letters, underscores, periods, or dashes");
}
public static bool TryParse(string input, [NotNullWhen(returnValue: true)] out PoolName? result) {
if (!IsValid(input)) {
result = default;
return false;
}
result = new PoolName(input);
return true;
}
public sealed class Converter : ValidatedStringConverter<PoolName> {
protected override bool TryParse(string input, out PoolName? output)
=> PoolName.TryParse(input, out output);
}
} }
[JsonConverter(typeof(Converter))] [JsonConverter(typeof(ValidatedStringConverter<Region>))]
public record Region : ValidatedString { public sealed record Region : ValidatedStringBase<Region>, IValidatedString<Region> {
private static bool IsValid(string input) => Check.IsAlnum(input); private Region(string value) : base(value.ToLowerInvariant()) { }
public static Region Parse(string input) => new(input);
private Region(string value) : base(value.ToLowerInvariant()) { public static bool IsValid(string input) => Check.IsAlnum(input);
Debug.Assert(IsValid(value)); public static string Requirements => "Region name must have only numbers or letters";
}
public static Region Parse(string input) {
if (TryParse(input, out var result)) {
return result;
}
throw new ArgumentException("Region name must have only numbers or letters");
}
public static bool TryParse(string input, [NotNullWhen(returnValue: true)] out Region? result) {
if (!IsValid(input)) {
result = default;
return false;
}
result = new Region(input);
return true;
}
public static implicit operator AzureLocation(Region me) => new(me.String); public static implicit operator AzureLocation(Region me) => new(me.String);
public static implicit operator Region(AzureLocation it) => new(it.Name); public static implicit operator Region(AzureLocation it) => new(it.Name);
public sealed class Converter : ValidatedStringConverter<Region> {
protected override bool TryParse(string input, out Region? output)
=> Region.TryParse(input, out output);
}
} }
[JsonConverter(typeof(Converter))] [JsonConverter(typeof(ValidatedStringConverter<Container>))]
public record Container : ValidatedString { public sealed record Container : ValidatedStringBase<Container>, IValidatedString<Container> {
// See: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage private Container(string value) : base(value) { }
// - 3-63 public static Container Parse(string input) => new(input);
// - Lowercase letters, numbers, and hyphens. public static bool IsValid(string input) => Check.IsStorageDnsLabel(input);
// - Start with lowercase letter or number. Can't use consecutive hyphens. public static string Requirements => "Container name must be 3-63 lowercase letters, numbers, or non-consecutive hyphens (see: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage)";
private static readonly Regex _containerRegex = new(@"\A(?!-)(?!.*--)[a-z0-9\-]{3,63}\z", RegexOptions.Compiled);
private static bool IsValid(string input) => _containerRegex.IsMatch(input);
private Container(string value) : base(value) {
Debug.Assert(IsValid(value));
}
public static Container Parse(string input) {
if (TryParse(input, out var result)) {
return result;
}
throw new ArgumentException("Container name must have only numbers, letters or dashes");
}
public static bool TryParse(string input, [NotNullWhen(returnValue: true)] out Container? result) {
if (!IsValid(input)) {
result = default;
return false;
}
result = new Container(input);
return true;
}
public sealed class Converter : ValidatedStringConverter<Container> {
protected override bool TryParse(string input, out Container? output)
=> Container.TryParse(input, out output);
}
} }

73
src/ApiService/ApiService/onefuzzlib/Request.cs
View File

@ -2,6 +2,7 @@
using System.Net; using System.Net;
using System.Text.Json; using System.Text.Json;
using System.Text.Json.Nodes; using System.Text.Json.Nodes;
using System.Text.Json.Serialization;
using Faithlife.Utility; using Faithlife.Utility;
using Microsoft.Azure.Functions.Worker.Http; using Microsoft.Azure.Functions.Worker.Http;
using Microsoft.OneFuzz.Service.OneFuzzLib.Orm; using Microsoft.OneFuzz.Service.OneFuzzLib.Orm;
@ -12,6 +13,48 @@ public interface IRequestHandling {
Async.Task<HttpResponseData> NotOk(HttpRequestData request, Error error, string context, HttpStatusCode statusCode = HttpStatusCode.BadRequest); Async.Task<HttpResponseData> NotOk(HttpRequestData request, Error error, string context, HttpStatusCode statusCode = HttpStatusCode.BadRequest);
} }
// See: https://www.rfc-editor.org/rfc/rfc7807#section-3
public sealed class ProblemDetails {
[JsonConstructor]
public ProblemDetails(int status, string title, string detail) {
Status = status;
Title = title;
Detail = detail;
}
public ProblemDetails(HttpStatusCode code, Error error) {
Status = (int)code;
Title = error.Code.ToString();
Detail = error.Errors?.Join("\n") ?? "";
}
// We do not yet use the type/instance properties:
/// A URI reference [RFC3986] that identifies the problem type. This
/// specification encourages that, when dereferenced, it provide
/// human-readable documentation for the problem type (e.g., using HTML
/// [W3C.REC-html5-20141028]). When this member is not present, its value
/// is assumed to be "about:blank".
// public string? Type { get; set; } = "about:blank";
/// A URI reference that identifies the specific occurrence of the problem.
/// It may or may not yield further information if dereferenced.
// public string? Instance { get; set; }
/// A short, human-readable summary of the problem type. It SHOULD NOT
/// change from occurrence to occurrence of the problem, except for purposes
/// of localization (e.g., using proactive content negotiation; see
/// [RFC7231], Section 3.4).
public string Title { get; set; }
/// The HTTP status code ([RFC7231], Section 6) generated by the origin
/// server for this occurrence of the problem.
public int Status { get; set; }
// A human-readable explanation specific to this occurrence of the problem.
public string Detail { get; set; }
}
public class RequestHandling : IRequestHandling { public class RequestHandling : IRequestHandling {
private readonly ILogTracer _log; private readonly ILogTracer _log;
public RequestHandling(ILogTracer log) { public RequestHandling(ILogTracer log) {
@ -22,9 +65,14 @@ public class RequestHandling : IRequestHandling {
if (statusNum >= 400 && statusNum <= 599) { if (statusNum >= 400 && statusNum <= 599) {
_log.Error($"request error: {context:Tag:Context} - {error:Tag:Error}"); _log.Error($"request error: {context:Tag:Context} - {error:Tag:Error}");
var response = HttpResponseData.CreateResponse(request); // emit standardized errors according to RFC7807:
await response.WriteAsJsonAsync(error); // https://www.rfc-editor.org/rfc/rfc7807
response.StatusCode = statusCode; var response = request.CreateResponse();
await response.WriteAsJsonAsync(
new ProblemDetails(statusCode, error),
"application/problem+json",
statusCode);
return response; return response;
} }
@ -33,7 +81,6 @@ public class RequestHandling : IRequestHandling {
public static async Async.Task<OneFuzzResult<T>> ParseRequest<T>(HttpRequestData req) public static async Async.Task<OneFuzzResult<T>> ParseRequest<T>(HttpRequestData req)
where T : BaseRequest { where T : BaseRequest {
Exception? exception = null;
try { try {
var t = await req.ReadFromJsonAsync<T>(); var t = await req.ReadFromJsonAsync<T>();
if (t != null) { if (t != null) {
@ -72,16 +119,8 @@ public class RequestHandling : IRequestHandling {
$"Failed to deserialize message into type: {typeof(T)} - null"); $"Failed to deserialize message into type: {typeof(T)} - null");
} }
} catch (Exception e) { } catch (Exception e) {
exception = e; return OneFuzzResult<T>.Error(ConvertError(e));
} }
if (exception != null) {
return OneFuzzResult<T>.Error(ConvertError(exception));
}
return OneFuzzResult<T>.Error(
ErrorCode.INVALID_REQUEST,
$"Failed to deserialize message into type: {typeof(T)} - {await req.ReadAsStringAsync()}"
);
} }
public static async Async.Task<OneFuzzResult<T>> ParseUri<T>(HttpRequestData req) { public static async Async.Task<OneFuzzResult<T>> ParseUri<T>(HttpRequestData req) {
@ -107,6 +146,14 @@ public class RequestHandling : IRequestHandling {
} }
public static Error ConvertError(Exception exception) { public static Error ConvertError(Exception exception) {
if (exception is AggregateException agg) {
var flattened = agg.Flatten();
if (flattened.InnerExceptions.Count == 1) {
// if we only have one inner exception, remove wrapping
return ConvertError(flattened.InnerExceptions[0]);
}
}
return new Error( return new Error(
ErrorCode.INVALID_REQUEST, ErrorCode.INVALID_REQUEST,
new string[] { new string[] {

8
src/ApiService/ApiService/onefuzzlib/orm/EntityConverter.cs
View File

@ -236,8 +236,12 @@ public class EntityConverter {
} else if (ef.type == typeof(long)) { } else if (ef.type == typeof(long)) {
return long.Parse(stringValue); return long.Parse(stringValue);
} else if (ef.type.IsClass) { } else if (ef.type.IsClass) {
if (ef.type.IsAssignableTo(typeof(ValidatedString))) { try {
return ef.type.GetMethod("Parse")!.Invoke(null, new[] { stringValue }); if (ef.type.GetMethod("Parse", BindingFlags.Static | BindingFlags.Public) is MethodInfo mi) {
return mi.Invoke(null, new[] { stringValue });
}
} catch (Exception ex) {
throw new ArgumentException($"Unable to parse '{stringValue}' as {ef.type}", ex);
} }
return Activator.CreateInstance(ef.type, new[] { stringValue }); return Activator.CreateInstance(ef.type, new[] { stringValue });

42
src/ApiService/FunctionalTests/1f-api/ApiBase.cs
View File

@ -75,12 +75,12 @@ public static class JsonElementExt {
return e.GetProperty(property).GetBoolean(); return e.GetProperty(property).GetBoolean();
} }
public static T GetObjectProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T>, new() { public static T GetObjectProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T> {
return new T().Convert(e.GetProperty(property)!); return T.Convert(e.GetProperty(property));
} }
public static T? GetNullableObjectProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T>, new() { public static T? GetNullableObjectProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T> {
return e.GetProperty(property).ValueKind == JsonValueKind.Null ? default(T) : new T().Convert(e.GetProperty(property)!); return e.GetProperty(property).ValueKind == JsonValueKind.Null ? default : T.Convert(e.GetProperty(property));
} }
public static IDictionary<string, string>? GetNullableStringDictProperty(this JsonElement e, string property) { public static IDictionary<string, string>? GetNullableStringDictProperty(this JsonElement e, string property) {
@ -91,10 +91,10 @@ public static class JsonElementExt {
return e.GetProperty(property).Deserialize<IDictionary<string, string>>()!; return e.GetProperty(property).Deserialize<IDictionary<string, string>>()!;
} }
public static IDictionary<string, T> GetDictProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T>, new() { public static IDictionary<string, T> GetDictProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T> {
return new Dictionary<string, T>( return new Dictionary<string, T>(
e.GetProperty(property)!.Deserialize<IDictionary<string, JsonElement>>()!.Select( e.GetProperty(property)!.Deserialize<IDictionary<string, JsonElement>>()!.Select(
kv => KeyValuePair.Create(kv.Key, new T().Convert(kv.Value)) kv => KeyValuePair.Create(kv.Key, T.Convert(kv.Value))
) )
); );
} }
@ -116,36 +116,36 @@ public static class JsonElementExt {
} }
public static IEnumerable<T> GetEnumerableProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T>, new() { public static IEnumerable<T> GetEnumerableProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T> {
return e.GetProperty(property).EnumerateArray().Select(e => new T().Convert(e)!); return e.GetProperty(property).EnumerateArray().Select(T.Convert);
} }
public static IEnumerable<T>? GetEnumerableNullableProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T>, new() { public static IEnumerable<T>? GetEnumerableNullableProperty<T>(this JsonElement e, string property) where T : IFromJsonElement<T> {
if (e.GetProperty(property).ValueKind == JsonValueKind.Null) if (e.GetProperty(property).ValueKind == JsonValueKind.Null)
return null; return null;
else else
return e.GetProperty(property).EnumerateArray().Select(e => new T().Convert(e)!); return e.GetProperty(property).EnumerateArray().Select(T.Convert);
} }
} }
public interface IFromJsonElement<T> { public interface IFromJsonElement<T> {
T Convert(JsonElement e); static abstract T Convert(JsonElement e);
} }
public class BooleanResult : IFromJsonElement<BooleanResult> { public class BooleanResult : IFromJsonElement<BooleanResult> {
JsonElement _e; readonly JsonElement _e;
public BooleanResult() { }
public BooleanResult(JsonElement e) => _e = e; public BooleanResult(JsonElement e) => _e = e;
public bool IsError => Error.IsError(_e); public bool IsError => Error.IsError(_e);
public Error? Error => new Error(_e); public Error? Error => new(_e);
public bool Result => _e.GetProperty("result").GetBoolean(); public bool Result => _e.GetProperty("result").GetBoolean();
public BooleanResult Convert(JsonElement e) => new BooleanResult(e); public static BooleanResult Convert(JsonElement e) => new(e);
} }
public abstract class ApiBase { public abstract class ApiBase {
@ -200,12 +200,12 @@ public abstract class ApiBase {
return (await JsonDocument.ParseAsync(r.Content.ReadAsStream())).RootElement; return (await JsonDocument.ParseAsync(r.Content.ReadAsStream())).RootElement;
} }
public static Result<IEnumerable<T>, Error> IEnumerableResult<T>(JsonElement res) where T : IFromJsonElement<T>, new() { public static Result<IEnumerable<T>, Error> IEnumerableResult<T>(JsonElement res) where T : IFromJsonElement<T> {
if (Error.IsError(res)) { if (Error.IsError(res)) {
return Result<IEnumerable<T>, Error>.Error(new Error(res)); return Result<IEnumerable<T>, Error>.Error(new Error(res));
} else { } else {
if (res.ValueKind == JsonValueKind.Array) if (res.ValueKind == JsonValueKind.Array)
return Result<IEnumerable<T>, Error>.Ok(res.EnumerateArray().Select(e => (new T()).Convert(e))); return Result<IEnumerable<T>, Error>.Ok(res.EnumerateArray().Select(T.Convert));
else { else {
var r = Result<T>(res); var r = Result<T>(res);
if (r.IsOk) if (r.IsOk)
@ -215,17 +215,17 @@ public abstract class ApiBase {
} }
} }
} }
public static Result<T, Error> Result<T>(JsonElement res) where T : IFromJsonElement<T>, new() { public static Result<T, Error> Result<T>(JsonElement res) where T : IFromJsonElement<T> {
if (Error.IsError(res)) { if (Error.IsError(res)) {
return Result<T, Error>.Error(new Error(res)); return Result<T, Error>.Error(new Error(res));
} else { } else {
Assert.True(res.ValueKind != JsonValueKind.Array); Assert.True(res.ValueKind != JsonValueKind.Array);
return Result<T, Error>.Ok((new T()).Convert(res)); return Result<T, Error>.Ok(T.Convert(res));
} }
} }
public static T Return<T>(JsonElement res) where T : IFromJsonElement<T>, new() { public static T Return<T>(JsonElement res) where T : IFromJsonElement<T> {
return (new T()).Convert(res); return T.Convert(res);
} }
} }

6
src/ApiService/FunctionalTests/1f-api/Authentication.cs
View File

@ -3,9 +3,8 @@
namespace FunctionalTests; namespace FunctionalTests;
public class Authentication : IFromJsonElement<Authentication> { public class Authentication : IFromJsonElement<Authentication> {
JsonElement _e; readonly JsonElement _e;
public Authentication() { }
public Authentication(JsonElement e) => _e = e; public Authentication(JsonElement e) => _e = e;
public string Password => _e.GetStringProperty("password"); public string Password => _e.GetStringProperty("password");
@ -13,6 +12,5 @@ public class Authentication : IFromJsonElement<Authentication> {
public string PublicKey => _e.GetStringProperty("public_key"); public string PublicKey => _e.GetStringProperty("public_key");
public string PrivateKey => _e.GetStringProperty("private_key"); public string PrivateKey => _e.GetStringProperty("private_key");
public Authentication Convert(JsonElement e) => new Authentication(e); public static Authentication Convert(JsonElement e) => new(e);
} }

5
src/ApiService/FunctionalTests/1f-api/Container.cs
View File

@ -5,10 +5,9 @@ using Xunit.Abstractions;
namespace FunctionalTests { namespace FunctionalTests {
public class ContainerInfo : IFromJsonElement<ContainerInfo> { public class ContainerInfo : IFromJsonElement<ContainerInfo> {
JsonElement _e; readonly JsonElement _e;
public ContainerInfo() { }
public ContainerInfo(JsonElement e) => _e = e; public ContainerInfo(JsonElement e) => _e = e;
public ContainerInfo Convert(JsonElement e) => new ContainerInfo(e); public static ContainerInfo Convert(JsonElement e) => new(e);
public string Name => _e.GetStringProperty("name"); public string Name => _e.GetStringProperty("name");
public IDictionary<string, string>? Metadata => _e.GetNullableStringDictProperty("metadata"); public IDictionary<string, string>? Metadata => _e.GetNullableStringDictProperty("metadata");
public Uri SasUrl => new Uri(_e.GetStringProperty("sas_url")); public Uri SasUrl => new Uri(_e.GetStringProperty("sas_url"));

52
src/ApiService/FunctionalTests/1f-api/Error.cs
View File

@ -1,26 +1,26 @@
using System.Text.Json; using System.Text.Json;
using Xunit;
namespace FunctionalTests; namespace FunctionalTests;
public class Error : IComparable<Error>, IFromJsonElement<Error> { public class Error : IComparable<Error>, IFromJsonElement<Error> {
JsonElement _e; private readonly JsonElement _e;
public Error() { }
public Error(JsonElement e) { public Error(JsonElement e) {
_e = e; _e = e;
Assert.True(_e.EnumerateObject().Count() == 2);
} }
public int Code => _e.GetIntProperty("code"); public int StatusCode => _e.GetIntProperty("status");
public IEnumerable<string> Errors => _e.GetEnumerableStringProperty("errors"); public string Title => _e.GetStringProperty("title");
public Error Convert(JsonElement e) => new Error(e); public string Detail => _e.GetStringProperty("detail");
public static Error Convert(JsonElement e) => new(e);
public static bool IsError(JsonElement res) { public static bool IsError(JsonElement res) {
return res.ValueKind == JsonValueKind.Object && res.TryGetProperty("code", out _) && res.TryGetProperty("errors", out _); return res.ValueKind == JsonValueKind.Object
&& res.TryGetProperty("title", out _)
&& res.TryGetProperty("detail", out _);
} }
public int CompareTo(Error? other) { public int CompareTo(Error? other) {
@ -28,16 +28,22 @@ public class Error : IComparable<Error>, IFromJsonElement<Error> {
return -1; return -1;
} }
var sameErrorMessages = Errors.Count() == other.Errors.Count(); var statusCompare = StatusCode.CompareTo(other.StatusCode);
foreach (var s in other.Errors) { if (statusCompare != 0) {
if (!sameErrorMessages) break; return statusCompare;
sameErrorMessages = Errors.Contains(s);
} }
if (other.Code == this.Code && sameErrorMessages) { var titleCompare = Title.CompareTo(other.Title);
return 0; if (titleCompare != 0) {
} else return titleCompare;
return 1; }
var detailCompare = Detail.CompareTo(other.Detail);
if (detailCompare != 0) {
return detailCompare;
}
return 0;
} }
public override string ToString() { public override string ToString() {
@ -45,15 +51,15 @@ public class Error : IComparable<Error>, IFromJsonElement<Error> {
} }
public bool IsWrongSizeError => public bool IsWrongSizeError =>
Code == 450 && Errors.First() == "The field Size must be between 1 and 9.223372036854776E+18."; Title == "INVALID_REQUEST" && Detail.Contains("The field Size must be between 1 and 9.223372036854776E+18.");
public bool UnableToFindPoolError => Code == 450 && Errors.First() == "unable to find pool"; public bool UnableToFindPoolError => Title == "INVALID_REQUEST" && Detail.Contains("unable to find pool");
public bool UnableToFindScalesetError => Code == 450 && Errors.First() == "unable to find scaleset"; public bool UnableToFindScalesetError => Title == "INVALID_REQUEST" && Detail.Contains("unable to find scaleset");
public bool UnableToFindNode => Code == 467 && Errors.First() == "unable to find node"; public bool UnableToFindNode => Title == "UNABLE_TO_FIND" && Detail.Contains("unable to find node");
public bool ShouldBeProvided(string p) => Code == 450 && Errors.First() == $"'{p}' query parameter must be provided"; public bool ShouldBeProvided(string p) => Title == "INVALID_REQUEST" && Detail.Contains($"'{p}' query parameter must be provided");
public bool UnableToFindTask => Code == 450 && Errors.First() == "unable to find task"; public bool UnableToFindTask => Title == "INVALID_REQUEST" && Detail.Contains("unable to find task");
} }

11
src/ApiService/FunctionalTests/1f-api/Info.cs
View File

@ -5,11 +5,10 @@ using Xunit.Abstractions;
namespace FunctionalTests { namespace FunctionalTests {
public class InfoVersion : IFromJsonElement<InfoVersion> { public class InfoVersion : IFromJsonElement<InfoVersion> {
JsonElement _e; readonly JsonElement _e;
public InfoVersion() { }
public InfoVersion(JsonElement e) => _e = e; public InfoVersion(JsonElement e) => _e = e;
public InfoVersion Convert(JsonElement e) => new InfoVersion(e); public static InfoVersion Convert(JsonElement e) => new(e);
public string Git => _e.GetProperty("git").GetString()!; public string Git => _e.GetProperty("git").GetString()!;
public string Build => _e.GetProperty("build").GetString()!; public string Build => _e.GetProperty("build").GetString()!;
@ -18,13 +17,11 @@ namespace FunctionalTests {
public class InfoResponse : IFromJsonElement<InfoResponse> { public class InfoResponse : IFromJsonElement<InfoResponse> {
JsonElement _e; readonly JsonElement _e;
public InfoResponse() { }
public InfoResponse(JsonElement e) => _e = e; public InfoResponse(JsonElement e) => _e = e;
public InfoResponse Convert(JsonElement e) => new InfoResponse(e); public static InfoResponse Convert(JsonElement e) => new(e);
public string ResourceGroup => _e.GetStringProperty("resource_group")!; public string ResourceGroup => _e.GetStringProperty("resource_group")!;
public string Region => _e.GetStringProperty("region")!; public string Region => _e.GetStringProperty("region")!;

11
src/ApiService/FunctionalTests/1f-api/Jobs.cs
View File

@ -5,13 +5,11 @@ using Xunit.Abstractions;
namespace FunctionalTests; namespace FunctionalTests;
public class JobTaskInfo : IFromJsonElement<JobTaskInfo> { public class JobTaskInfo : IFromJsonElement<JobTaskInfo> {
JsonElement _e; readonly JsonElement _e;
public JobTaskInfo() { }
public JobTaskInfo(JsonElement e) => _e = e; public JobTaskInfo(JsonElement e) => _e = e;
public JobTaskInfo Convert(JsonElement e) => new JobTaskInfo(e); public static JobTaskInfo Convert(JsonElement e) => new(e);
public Guid TaskId => _e.GetGuidProperty("task_id"); public Guid TaskId => _e.GetGuidProperty("task_id");
@ -22,12 +20,11 @@ public class JobTaskInfo : IFromJsonElement<JobTaskInfo> {
public class Job : IFromJsonElement<Job> { public class Job : IFromJsonElement<Job> {
JsonElement _e; readonly JsonElement _e;
public Job() { }
public Job(JsonElement e) => _e = e; public Job(JsonElement e) => _e = e;
public Job Convert(JsonElement e) => new Job(e); public static Job Convert(JsonElement e) => new(e);
public Guid JobId => _e.GetGuidProperty("job_id"); public Guid JobId => _e.GetGuidProperty("job_id");

6
src/ApiService/FunctionalTests/1f-api/Node.cs
View File

@ -6,9 +6,7 @@ using Xunit.Abstractions;
namespace FunctionalTests; namespace FunctionalTests;
public class Node : IFromJsonElement<Node> { public class Node : IFromJsonElement<Node> {
JsonElement _e; readonly JsonElement _e;
public Node() { }
public Node(JsonElement e) => _e = e; public Node(JsonElement e) => _e = e;
@ -31,7 +29,7 @@ public class Node : IFromJsonElement<Node> {
public bool DeleteRequested => _e.GetBoolProperty("delete_requested"); public bool DeleteRequested => _e.GetBoolProperty("delete_requested");
public bool DebugKeepNode => _e.GetBoolProperty("debug_keep_node"); public bool DebugKeepNode => _e.GetBoolProperty("debug_keep_node");
public Node Convert(JsonElement e) => new Node(e); public static Node Convert(JsonElement e) => new(e);
} }

6
src/ApiService/FunctionalTests/1f-api/Notifications.cs
View File

@ -5,13 +5,11 @@ using Xunit.Abstractions;
namespace FunctionalTests; namespace FunctionalTests;
public class Notification : IFromJsonElement<Notification> { public class Notification : IFromJsonElement<Notification> {
JsonElement _e; readonly JsonElement _e;
public Notification() { }
public Notification(JsonElement e) => _e = e; public Notification(JsonElement e) => _e = e;
public Notification Convert(JsonElement e) => new Notification(e); public static Notification Convert(JsonElement e) => new(e);
public Guid NotificationId => _e.GetGuidProperty("notification_id"); public Guid NotificationId => _e.GetGuidProperty("notification_id");

5
src/ApiService/FunctionalTests/1f-api/Pool.cs
View File

@ -7,11 +7,10 @@ namespace FunctionalTests;
public class Pool : IFromJsonElement<Pool> { public class Pool : IFromJsonElement<Pool> {
JsonElement _e; readonly JsonElement _e;
public Pool() { }
public Pool(JsonElement e) => _e = e; public Pool(JsonElement e) => _e = e;
public Pool Convert(JsonElement e) => new Pool(e); public static Pool Convert(JsonElement e) => new(e);
public string Name => _e.GetStringProperty("name"); public string Name => _e.GetStringProperty("name");
public string PoolId => _e.GetStringProperty("pool_id"); public string PoolId => _e.GetStringProperty("pool_id");

15
src/ApiService/FunctionalTests/1f-api/Proxy.cs
View File

@ -4,8 +4,7 @@ using Xunit.Abstractions;
namespace FunctionalTests; namespace FunctionalTests;
public class Proxy : IFromJsonElement<Proxy> { public class Proxy : IFromJsonElement<Proxy> {
readonly JsonElement _e;
JsonElement _e;
public Proxy() { } public Proxy() { }
public Proxy(JsonElement e) => _e = e; public Proxy(JsonElement e) => _e = e;
@ -14,11 +13,11 @@ public class Proxy : IFromJsonElement<Proxy> {
public string VmState => _e.GetStringProperty("state"); public string VmState => _e.GetStringProperty("state");
public Proxy Convert(JsonElement e) => new Proxy(e); public static Proxy Convert(JsonElement e) => new(e);
} }
public class Forward : IFromJsonElement<Forward>, IComparable<Forward> { public class Forward : IFromJsonElement<Forward>, IComparable<Forward> {
JsonElement _e; readonly JsonElement _e;
public Forward() { } public Forward() { }
public Forward(JsonElement e) => _e = e; public Forward(JsonElement e) => _e = e;
@ -27,7 +26,7 @@ public class Forward : IFromJsonElement<Forward>, IComparable<Forward> {
public string DstIp => _e.GetStringProperty("dst_ip"); public string DstIp => _e.GetStringProperty("dst_ip");
public Forward Convert(JsonElement e) => new Forward(e); public static Forward Convert(JsonElement e) => new(e);
public int CompareTo(Forward? other) { public int CompareTo(Forward? other) {
if (other == null) return 1; if (other == null) return 1;
@ -41,7 +40,7 @@ public class Forward : IFromJsonElement<Forward>, IComparable<Forward> {
} }
public class ProxyGetResult : IFromJsonElement<ProxyGetResult>, IComparable<ProxyGetResult> { public class ProxyGetResult : IFromJsonElement<ProxyGetResult>, IComparable<ProxyGetResult> {
JsonElement _e; readonly JsonElement _e;
public ProxyGetResult() { } public ProxyGetResult() { }
@ -62,9 +61,9 @@ public class ProxyGetResult : IFromJsonElement<ProxyGetResult>, IComparable<Prox
} }
} }
public Forward Forward => new Forward(_e.GetProperty("forward")); public Forward Forward => new(_e.GetProperty("forward"));
public ProxyGetResult Convert(JsonElement e) => new ProxyGetResult(e); public static ProxyGetResult Convert(JsonElement e) => new(e);
public int CompareTo(ProxyGetResult? other) { public int CompareTo(ProxyGetResult? other) {

10
src/ApiService/FunctionalTests/1f-api/ReproVmss.cs
View File

@ -5,12 +5,11 @@ using Xunit.Abstractions;
namespace FunctionalTests; namespace FunctionalTests;
public class ReproConfig : IFromJsonElement<ReproConfig> { public class ReproConfig : IFromJsonElement<ReproConfig> {
JsonElement _e; readonly JsonElement _e;
public ReproConfig() { }
public ReproConfig(JsonElement e) => _e = e; public ReproConfig(JsonElement e) => _e = e;
public ReproConfig Convert(JsonElement e) => new ReproConfig(e); public static ReproConfig Convert(JsonElement e) => new(e);
public string Container => _e.GetStringProperty("container"); public string Container => _e.GetStringProperty("container");
public string Path => _e.GetStringProperty("path"); public string Path => _e.GetStringProperty("path");
@ -20,12 +19,11 @@ public class ReproConfig : IFromJsonElement<ReproConfig> {
public class Repro : IFromJsonElement<Repro> { public class Repro : IFromJsonElement<Repro> {
JsonElement _e; readonly JsonElement _e;
public Repro() { }
public Repro(JsonElement e) => _e = e; public Repro(JsonElement e) => _e = e;
public Repro Convert(JsonElement e) => new Repro(e); public static Repro Convert(JsonElement e) => new(e);
public Guid VmId => _e.GetGuidProperty("vm_id"); public Guid VmId => _e.GetGuidProperty("vm_id");

10
src/ApiService/FunctionalTests/1f-api/Scaleset.cs
View File

@ -6,12 +6,11 @@ using Xunit.Abstractions;
namespace FunctionalTests; namespace FunctionalTests;
public class ScalesetNodeState : IFromJsonElement<ScalesetNodeState> { public class ScalesetNodeState : IFromJsonElement<ScalesetNodeState> {
JsonElement _e; readonly JsonElement _e;
public ScalesetNodeState() { }
public ScalesetNodeState(JsonElement e) => _e = e; public ScalesetNodeState(JsonElement e) => _e = e;
public ScalesetNodeState Convert(JsonElement e) => new ScalesetNodeState(e); public static ScalesetNodeState Convert(JsonElement e) => new(e);
public Guid MachineId => _e.GetGuidProperty("machine_id"); public Guid MachineId => _e.GetGuidProperty("machine_id");
public string InstanceId => _e.GetStringProperty("instance_id"); public string InstanceId => _e.GetStringProperty("instance_id");
@ -20,10 +19,9 @@ public class ScalesetNodeState : IFromJsonElement<ScalesetNodeState> {
} }
public class Scaleset : IFromJsonElement<Scaleset> { public class Scaleset : IFromJsonElement<Scaleset> {
JsonElement _e; readonly JsonElement _e;
public Scaleset() { }
public Scaleset(JsonElement e) => _e = e; public Scaleset(JsonElement e) => _e = e;
public Scaleset Convert(JsonElement e) => new Scaleset(e); public static Scaleset Convert(JsonElement e) => new(e);
public Guid ScalesetId => _e.GetGuidProperty("scaleset_id"); public Guid ScalesetId => _e.GetGuidProperty("scaleset_id");
public string PoolName => _e.GetStringProperty("pool_name"); public string PoolName => _e.GetStringProperty("pool_name");

13
src/ApiService/FunctionalTests/1f-api/Tasks.cs
View File

@ -6,8 +6,7 @@ namespace FunctionalTests;
public class TaskDetails { public class TaskDetails {
JsonElement _e; readonly JsonElement _e;
public TaskDetails() { }
public TaskDetails(JsonElement e) => _e = e; public TaskDetails(JsonElement e) => _e = e;
public string Type => _e.GetStringProperty("type"); public string Type => _e.GetStringProperty("type");
@ -77,22 +76,20 @@ public class TaskDetails {
public class TaskConfig : IFromJsonElement<TaskConfig> { public class TaskConfig : IFromJsonElement<TaskConfig> {
JsonElement _e; readonly JsonElement _e;
public TaskConfig() { }
public TaskConfig(JsonElement e) => _e = e; public TaskConfig(JsonElement e) => _e = e;
public TaskConfig Convert(JsonElement e) => new TaskConfig(e); public static TaskConfig Convert(JsonElement e) => new(e);
public Guid JobId => _e.GetGuidProperty("job_id"); public Guid JobId => _e.GetGuidProperty("job_id");
public IEnumerable<Guid>? PrereqTasks => _e.GetEnumerableGuidProperty("prereq_tasks"); public IEnumerable<Guid>? PrereqTasks => _e.GetEnumerableGuidProperty("prereq_tasks");
} }
public class OneFuzzTask : IFromJsonElement<OneFuzzTask> { public class OneFuzzTask : IFromJsonElement<OneFuzzTask> {
JsonElement _e; readonly JsonElement _e;
public OneFuzzTask() { }
public OneFuzzTask(JsonElement e) => _e = e; public OneFuzzTask(JsonElement e) => _e = e;
public OneFuzzTask Convert(JsonElement e) => new OneFuzzTask(e); public static OneFuzzTask Convert(JsonElement e) => new(e);
public Guid JobId => _e.GetGuidProperty("job_id"); public Guid JobId => _e.GetGuidProperty("job_id");
public Guid TaskId => _e.GetGuidProperty("task_id"); public Guid TaskId => _e.GetGuidProperty("task_id");

6
src/ApiService/FunctionalTests/1f-api/UserInfo.cs
View File

@ -4,13 +4,11 @@ namespace FunctionalTests;
public class UserInfo : IFromJsonElement<UserInfo> { public class UserInfo : IFromJsonElement<UserInfo> {
JsonElement _e; readonly JsonElement _e;
public UserInfo() { }
public UserInfo(JsonElement e) => _e = e; public UserInfo(JsonElement e) => _e = e;
public UserInfo Convert(JsonElement e) => new UserInfo(e); public static UserInfo Convert(JsonElement e) => new(e);
public Guid? ApplicationId => _e.GetNullableGuidProperty("application_id"); public Guid? ApplicationId => _e.GetNullableGuidProperty("application_id");
public Guid? ObjectId => _e.GetNullableGuidProperty("object_id"); public Guid? ObjectId => _e.GetNullableGuidProperty("object_id");
public string? Upn => _e.GetNullableStringProperty("upn"); public string? Upn => _e.GetNullableStringProperty("upn");
} }

24
src/ApiService/IntegrationTests/AgentRegistrationTests.cs
View File

@ -69,9 +69,9 @@ public abstract class AgentRegistrationTestsBase : FunctionTestBase {
var result = await func.Run(req); var result = await func.Run(req);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var body = BodyAs<Error>(result); var body = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_REQUEST, body.Code); Assert.Equal(ErrorCode.INVALID_REQUEST.ToString(), body.Title);
Assert.Equal("'machine_id' query parameter must be provided", body.Errors?.Single()); Assert.Equal("'machine_id' query parameter must be provided", body.Detail);
} }
[Fact] [Fact]
@ -85,9 +85,9 @@ public abstract class AgentRegistrationTestsBase : FunctionTestBase {
var result = await func.Run(req); var result = await func.Run(req);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var body = BodyAs<Error>(result); var body = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_REQUEST, body.Code); Assert.Equal(ErrorCode.INVALID_REQUEST.ToString(), body.Title);
Assert.Contains("unable to find a registration", body.Errors?.Single()); Assert.Contains("unable to find a registration", body.Detail);
} }
[Fact] [Fact]
@ -104,9 +104,9 @@ public abstract class AgentRegistrationTestsBase : FunctionTestBase {
var result = await func.Run(req); var result = await func.Run(req);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var body = BodyAs<Error>(result); var body = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_REQUEST, body.Code); Assert.Equal(ErrorCode.INVALID_REQUEST.ToString(), body.Title);
Assert.Contains("unable to find a pool", body.Errors?.Single()); Assert.Contains("unable to find a pool", body.Detail);
} }
[Fact] [Fact]
@ -220,8 +220,8 @@ public abstract class AgentRegistrationTestsBase : FunctionTestBase {
var result = await func.Run(req); var result = await func.Run(req);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_REQUEST, err.Code); Assert.Equal(ErrorCode.INVALID_REQUEST.ToString(), err.Title);
Assert.Equal($"'{parameterToSkip}' query parameter must be provided", err.Errors?.Single()); Assert.Equal($"'{parameterToSkip}' query parameter must be provided", err.Detail);
} }
} }

19
src/ApiService/IntegrationTests/ContainersTests.cs
View File

@ -41,8 +41,8 @@ public abstract class ContainersTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.Empty(method)); var result = await func.Run(TestHttpRequestData.Empty(method));
Assert.Equal(HttpStatusCode.Unauthorized, result.StatusCode); Assert.Equal(HttpStatusCode.Unauthorized, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.UNAUTHORIZED, err.Code); Assert.Equal(ErrorCode.UNAUTHORIZED.ToString(), err.Title);
} }
@ -174,4 +174,19 @@ public abstract class ContainersTestBase : FunctionTestBase {
} }
using var r = await client.DeleteBlobAsync("blob"); // delete using var r = await client.DeleteBlobAsync("blob"); // delete
} }
[Fact]
public async Async.Task BadContainerNameProducesGoodErrorMessage() {
// use anonymous type so we can send an invalid name
var msg = TestHttpRequestData.FromJson("POST", new { Name = "AbCd" });
var auth = new TestEndpointAuthorization(RequestType.User, Logger, Context);
var func = new ContainersFunction(Logger, auth, Context);
var result = await func.Run(msg);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var details = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_REQUEST.ToString(), details.Title);
Assert.StartsWith("Unable to parse 'AbCd' as a Container: Container name must", details.Detail);
}
} }

12
src/ApiService/IntegrationTests/DownloadTests.cs
View File

@ -34,8 +34,8 @@ public abstract class DownloadTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.Empty("GET")); var result = await func.Run(TestHttpRequestData.Empty("GET"));
Assert.Equal(HttpStatusCode.Unauthorized, result.StatusCode); Assert.Equal(HttpStatusCode.Unauthorized, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.UNAUTHORIZED, err.Code); Assert.Equal(ErrorCode.UNAUTHORIZED.ToString(), err.Title);
} }
[Fact] [Fact]
@ -49,8 +49,8 @@ public abstract class DownloadTestBase : FunctionTestBase {
var result = await func.Run(req); var result = await func.Run(req);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_REQUEST, err.Code); Assert.Equal(ErrorCode.INVALID_REQUEST.ToString(), err.Title);
} }
[Fact] [Fact]
@ -65,8 +65,8 @@ public abstract class DownloadTestBase : FunctionTestBase {
var result = await func.Run(req); var result = await func.Run(req);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_REQUEST, err.Code); Assert.Equal(ErrorCode.INVALID_REQUEST.ToString(), err.Title);
} }
[Fact] [Fact]

8
src/ApiService/IntegrationTests/JobsTests.cs
View File

@ -40,8 +40,8 @@ public abstract class JobsTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.Empty(method)); var result = await func.Run(TestHttpRequestData.Empty(method));
Assert.Equal(HttpStatusCode.Unauthorized, result.StatusCode); Assert.Equal(HttpStatusCode.Unauthorized, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.UNAUTHORIZED, err.Code); Assert.Equal(ErrorCode.UNAUTHORIZED.ToString(), err.Title);
} }
[Fact] [Fact]
@ -52,8 +52,8 @@ public abstract class JobsTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.FromJson("DELETE", new JobGet(_jobId))); var result = await func.Run(TestHttpRequestData.FromJson("DELETE", new JobGet(_jobId)));
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.INVALID_JOB, err.Code); Assert.Equal(ErrorCode.INVALID_JOB.ToString(), err.Title);
} }
[Fact] [Fact]

17
src/ApiService/IntegrationTests/NodeTests.cs
View File

@ -1,7 +1,6 @@
 
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;
using System.Net; using System.Net;
using IntegrationTests.Fakes; using IntegrationTests.Fakes;
using Microsoft.OneFuzz.Service; using Microsoft.OneFuzz.Service;
@ -171,9 +170,9 @@ public abstract class NodeTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.FromJson(method, req)); var result = await func.Run(TestHttpRequestData.FromJson(method, req));
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.UNAUTHORIZED, err.Code); Assert.Equal(ErrorCode.UNAUTHORIZED.ToString(), err.Title);
Assert.Contains("pool modification disabled", err.Errors?.Single()); Assert.Contains("pool modification disabled", err.Detail);
} }
[Theory] [Theory]
@ -201,7 +200,7 @@ public abstract class NodeTestBase : FunctionTestBase {
// we will fail with BadRequest but due to not being able to find the Node, // we will fail with BadRequest but due to not being able to find the Node,
// not because of UNAUTHORIZED // not because of UNAUTHORIZED
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
Assert.Equal(ErrorCode.UNABLE_TO_FIND, BodyAs<Error>(result).Code); Assert.Equal(ErrorCode.UNABLE_TO_FIND.ToString(), BodyAs<ProblemDetails>(result).Title);
} }
[Theory] [Theory]
@ -231,7 +230,7 @@ public abstract class NodeTestBase : FunctionTestBase {
// we will fail with BadRequest but due to not being able to find the Node, // we will fail with BadRequest but due to not being able to find the Node,
// not because of UNAUTHORIZED // not because of UNAUTHORIZED
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
Assert.Equal(ErrorCode.UNABLE_TO_FIND, BodyAs<Error>(result).Code); Assert.Equal(ErrorCode.UNABLE_TO_FIND.ToString(), BodyAs<ProblemDetails>(result).Title);
} }
[Theory] [Theory]
@ -260,9 +259,9 @@ public abstract class NodeTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.FromJson(method, req)); var result = await func.Run(TestHttpRequestData.FromJson(method, req));
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(ErrorCode.UNAUTHORIZED, err.Code); Assert.Equal(ErrorCode.UNAUTHORIZED.ToString(), err.Title);
Assert.Contains("not authorized to manage instance", err.Errors?.Single()); Assert.Contains("not authorized to manage instance", err.Detail);
} }
[Theory] [Theory]

4
src/ApiService/IntegrationTests/PoolTests.cs
View File

@ -252,7 +252,7 @@ public abstract class PoolTestBase : FunctionTestBase {
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
// should get an error back // should get an error back
var returnedPool = BodyAs<Error>(result); var returnedPool = BodyAs<ProblemDetails>(result);
Assert.Contains(returnedPool.Errors, c => c == "pool with that name already exists"); Assert.Contains("pool with that name already exists", returnedPool.Detail);
} }
} }

5
src/ApiService/IntegrationTests/ScalesetTests.cs
View File

@ -1,6 +1,5 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;
using System.Net; using System.Net;
using IntegrationTests.Fakes; using IntegrationTests.Fakes;
using Microsoft.OneFuzz.Service; using Microsoft.OneFuzz.Service;
@ -51,8 +50,8 @@ public abstract class ScalesetTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.FromJson("GET", req)); var result = await func.Run(TestHttpRequestData.FromJson("GET", req));
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal("unable to find scaleset", err.Errors?.Single()); Assert.Equal("unable to find scaleset", err.Detail);
} }
[Fact] [Fact]

8
src/ApiService/IntegrationTests/TasksTests.cs
View File

@ -45,8 +45,8 @@ public abstract class TasksTestBase : FunctionTestBase {
var testData = new TestHttpRequestData("POST", new BinaryData(JsonSerializer.SerializeToUtf8Bytes(serialized, EntityConverter.GetJsonSerializerOptions()))); var testData = new TestHttpRequestData("POST", new BinaryData(JsonSerializer.SerializeToUtf8Bytes(serialized, EntityConverter.GetJsonSerializerOptions())));
var result = await func.Run(testData); var result = await func.Run(testData);
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(new[] { "Unexpected property: \"vm\"" }, err.Errors); Assert.Equal("Unexpected property: \"vm\"", err.Detail);
} }
[Fact] [Fact]
@ -66,8 +66,8 @@ public abstract class TasksTestBase : FunctionTestBase {
var result = await func.Run(TestHttpRequestData.FromJson("POST", req)); var result = await func.Run(TestHttpRequestData.FromJson("POST", req));
Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode); Assert.Equal(HttpStatusCode.BadRequest, result.StatusCode);
var err = BodyAs<Error>(result); var err = BodyAs<ProblemDetails>(result);
Assert.Equal(new[] { "The Pool field is required." }, err.Errors); Assert.Equal("The Pool field is required.", err.Detail);
} }
[Fact] [Fact]

6
src/ApiService/Tests/OrmModelsTest.cs
View File

@ -88,12 +88,12 @@ namespace Tests {
public static Gen<PoolName> PoolNameGen { get; } public static Gen<PoolName> PoolNameGen { get; }
= from name in Arb.Generate<NonEmptyString>() = from name in Arb.Generate<NonEmptyString>()
where PoolName.TryParse(name.Get, out _) where PoolName.IsValid(name.Get)
select PoolName.Parse(name.Get); select PoolName.Parse(name.Get);
public static Gen<Region> RegionGen { get; } public static Gen<Region> RegionGen { get; }
= from name in Arb.Generate<NonEmptyString>() = from name in Arb.Generate<NonEmptyString>()
where Region.TryParse(name.Get, out _) where Region.IsValid(name.Get)
select Region.Parse(name.Get); select Region.Parse(name.Get);
public static Gen<Node> Node { get; } public static Gen<Node> Node { get; }
@ -365,7 +365,7 @@ namespace Tests {
from len in Gen.Choose(3, 63) from len in Gen.Choose(3, 63)
from name in Gen.ArrayOf(len, Gen.Elements<char>("abcdefghijklmnopqrstuvwxyz0123456789-")) from name in Gen.ArrayOf(len, Gen.Elements<char>("abcdefghijklmnopqrstuvwxyz0123456789-"))
let nameString = new string(name) let nameString = new string(name)
where Container.TryParse(nameString, out var _) where Container.IsValid(nameString)
select Container.Parse(nameString); select Container.Parse(nameString);
public static Gen<ADODuplicateTemplate> AdoDuplicateTemplate() { public static Gen<ADODuplicateTemplate> AdoDuplicateTemplate() {

4
src/ApiService/Tests/ValidatedStringTests.cs
View File

@ -31,7 +31,7 @@ public class ValidatedStringTests {
[InlineData("container-Name", false)] // can't have capitals [InlineData("container-Name", false)] // can't have capitals
[InlineData("container-name-09", true)] // can have numbers [InlineData("container-name-09", true)] // can have numbers
public void ContainerNames(string name, bool valid) { public void ContainerNames(string name, bool valid) {
Assert.Equal(valid, Container.TryParse(name, out var _)); Assert.Equal(valid, Container.IsValid(name));
} }
[Theory(Skip = "Validation is disabled for now")] [Theory(Skip = "Validation is disabled for now")]
@ -40,6 +40,6 @@ public class ValidatedStringTests {
[InlineData("Default-Ubuntu20.04-Standard_D2", true)] [InlineData("Default-Ubuntu20.04-Standard_D2", true)]
[InlineData("Default!", false)] [InlineData("Default!", false)]
public void PoolNames(string name, bool valid) { public void PoolNames(string name, bool valid) {
Assert.Equal(valid, PoolName.TryParse(name, out var _)); Assert.Equal(valid, PoolName.IsValid(name));
} }
} }

20
src/cli/onefuzz/backend.py
View File

@ -82,9 +82,9 @@ def check_application_error(response: requests.Response) -> None:
if response.status_code == 401: if response.status_code == 401:
try: try:
as_json = json.loads(response.content) as_json = json.loads(response.content)
if isinstance(as_json, dict) and "code" in as_json and "errors" in as_json: if isinstance(as_json, dict) and "title" in as_json and "detail" in as_json:
raise Exception( raise Exception(
f"request failed: application error - {as_json['code']} {as_json['errors']}" f"request failed: application error (401: {as_json['title']}): {as_json['detail']}"
) )
except json.decoder.JSONDecodeError: except json.decoder.JSONDecodeError:
pass pass
@ -351,7 +351,20 @@ class Backend:
if response is None: if response is None:
raise Exception("request failed: %s %s" % (method, url)) raise Exception("request failed: %s %s" % (method, url))
if response.status_code / 100 != 2: if response.status_code // 100 != 2:
try:
json = response.json()
except requests.exceptions.JSONDecodeError:
pass
# attempt to read as https://www.rfc-editor.org/rfc/rfc7807
if isinstance(json, Dict):
title = json.get("title")
details = json.get("detail")
raise Exception(
f"request did not succeed ({response.status_code}: {title}): {details}"
)
error_text = str( error_text = str(
response.content, encoding="utf-8", errors="backslashreplace" response.content, encoding="utf-8", errors="backslashreplace"
) )
@ -359,6 +372,7 @@ class Backend:
"request did not succeed: HTTP %s - %s" "request did not succeed: HTTP %s - %s"
% (response.status_code, error_text) % (response.status_code, error_text)
) )
return response return response