forked from dee-kryvenko/runner
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename AcquireJobRequest::StreamID to AcquireJobRequest::JobMessageID (…
…actions#2547) * Rename AcquireJobRequest::StreamID to AcquireJobRequest::JobMessageID to match corresponding server-side update. * appeased the linter * Added unit tests to prove AcquireJobRequest serialization/deserialization is as-expected. * Distinguish unit test variations. * Incorporated PR Feedback.
- Loading branch information
Showing
3 changed files
with
72 additions
and
5 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,13 +1,16 @@ | ||
using System.Collections.Generic; | ||
using System.Runtime.Serialization; | ||
using GitHub.DistributedTask.WebApi; | ||
|
||
namespace GitHub.Actions.RunService.WebApi | ||
{ | ||
[DataContract] | ||
public class AcquireJobRequest | ||
{ | ||
[DataMember(Name = "jobMessageId", EmitDefaultValue = false)] | ||
public string JobMessageId { get; set; } | ||
|
||
// This field will be removed in an upcoming Runner release. | ||
// It's left here temporarily to facilitate the transition to the new field name, JobMessageId. | ||
[DataMember(Name = "streamId", EmitDefaultValue = false)] | ||
public string StreamID { get; set; } | ||
public string StreamId { get; set; } | ||
} | ||
} | ||
} |
This file contains 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 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,63 @@ | ||
using System.Collections.Generic; | ||
using System.IO; | ||
using System.Runtime.Serialization.Json; | ||
using System.Text; | ||
using Xunit; | ||
|
||
namespace GitHub.Actions.RunService.WebApi.Tests; | ||
|
||
public sealed class AcquireJobRequestL0 | ||
{ | ||
|
||
[Fact] | ||
[Trait("Level", "L0")] | ||
[Trait("Category", "Common")] | ||
public void VerifySerialization() | ||
{ | ||
var jobMessageId = "1526919030369-33"; | ||
var request = new AcquireJobRequest | ||
{ | ||
JobMessageId = jobMessageId, | ||
StreamId = jobMessageId | ||
}; | ||
var serializer = new DataContractJsonSerializer(typeof(AcquireJobRequest)); | ||
using var stream = new MemoryStream(); | ||
serializer.WriteObject(stream, request); | ||
|
||
stream.Position = 0; | ||
using var reader = new StreamReader(stream, Encoding.UTF8); | ||
string json = reader.ReadToEnd(); | ||
string expected = DoubleQuotify(string.Format("{{'jobMessageId':'{0}','streamId':'{0}'}}", request.JobMessageId)); | ||
Assert.Equal(expected, json); | ||
|
||
} | ||
|
||
[Fact] | ||
[Trait("Level", "L0")] | ||
[Trait("Category", "Common")] | ||
public void VerifyDeserialization() | ||
{ | ||
var serializer = new DataContractJsonSerializer(typeof(AcquireJobRequest)); | ||
var variations = new Dictionary<string, string>() | ||
{ | ||
["{'streamId': 'legacy', 'jobMessageId': 'new-1'}"] = "new-1", | ||
["{'jobMessageId': 'new-2', 'streamId': 'legacy'}"] = "new-2", | ||
["{'jobMessageId': 'new-3'}"] = "new-3" | ||
}; | ||
|
||
foreach (var (source, expected) in variations) | ||
{ | ||
using var stream = new MemoryStream(); | ||
stream.Write(Encoding.UTF8.GetBytes(DoubleQuotify(source))); | ||
stream.Position = 0; | ||
var recoveredRecord = serializer.ReadObject(stream) as AcquireJobRequest; | ||
Assert.NotNull(recoveredRecord); | ||
Assert.Equal(expected, recoveredRecord.JobMessageId); | ||
} | ||
} | ||
|
||
private static string DoubleQuotify(string text) | ||
{ | ||
return text.Replace('\'', '"'); | ||
} | ||
} |