Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit559b111

Browse files
authored
chore: rework RPC version to match new header spec (#8)
1 parent08487ac commit559b111

File tree

8 files changed

+337
-157
lines changed

8 files changed

+337
-157
lines changed

‎Tests/Vpn.Proto/ApiVersionTest.cs

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎Tests/Vpn.Proto/RpcHeaderTest.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ public class RpcHeaderTest
99
[Test(Description="Parse and use some valid header strings")]
1010
publicvoidValid()
1111
{
12-
varheaderStr="codervpn 2.1 manager";
12+
varheaderStr="codervpnmanager 1.3,2.1";
1313
varheader=RpcHeader.Parse(headerStr);
1414
Assert.That(header.Role.ToString(),Is.EqualTo(RpcRole.Manager));
15-
Assert.That(header.Version,Is.EqualTo(newApiVersion(2,1)));
15+
Assert.That(header.VersionList,Is.EqualTo(newRpcVersionList(newRpcVersion(1,3),newRpcVersion(2,1))));
1616
Assert.That(header.ToString(),Is.EqualTo(headerStr+"\n"));
1717
Assert.That(header.ToBytes().ToArray(),Is.EqualTo(Encoding.UTF8.GetBytes(headerStr+"\n")));
1818

19-
headerStr="codervpn 1.0 tunnel";
19+
headerStr="codervpntunnel1.0";
2020
header=RpcHeader.Parse(headerStr);
2121
Assert.That(header.Role.ToString(),Is.EqualTo(RpcRole.Tunnel));
22-
Assert.That(header.Version,Is.EqualTo(newApiVersion(1,0)));
22+
Assert.That(header.VersionList,Is.EqualTo(newRpcVersionList(newRpcVersion(1,0))));
2323
Assert.That(header.ToString(),Is.EqualTo(headerStr+"\n"));
2424
Assert.That(header.ToBytes().ToArray(),Is.EqualTo(Encoding.UTF8.GetBytes(headerStr+"\n")));
2525
}
@@ -29,13 +29,13 @@ public void ParseInvalid()
2929
{
3030
varex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("codervpn"));
3131
Assert.That(ex.Message,Does.Contain("Wrong number of parts"));
32-
ex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("codervpn1.0manager cats"));
32+
ex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("codervpn manager cats 1.0"));
3333
Assert.That(ex.Message,Does.Contain("Wrong number of parts"));
3434
ex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("codervpn 1.0"));
3535
Assert.That(ex.Message,Does.Contain("Wrong number of parts"));
36-
ex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("cats 1.0 manager"));
36+
ex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("catsmanager1.0"));
3737
Assert.That(ex.Message,Does.Contain("Invalid preamble"));
38-
ex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("codervpn 1.0 cats"));
38+
ex=Assert.Throws<ArgumentException>(()=>RpcHeader.Parse("codervpncats1.0"));
3939
Assert.That(ex.Message,Does.Contain("Unknown role 'cats'"));
4040
}
4141
}

‎Tests/Vpn.Proto/RpcVersionTest.cs

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
usingCoder.Desktop.Vpn.Proto;
2+
usingNUnit.Framework.Constraints;
3+
4+
namespaceCoder.Desktop.Tests.Vpn.Proto;
5+
6+
[TestFixture]
7+
publicclassRpcVersionTest
8+
{
9+
[Test(Description="Parse a variety of version strings")]
10+
publicvoidParse()
11+
{
12+
Assert.That(RpcVersion.Parse("2.1"),Is.EqualTo(newRpcVersion(2,1)));
13+
Assert.That(RpcVersion.Parse("1.0"),Is.EqualTo(newRpcVersion(1,0)));
14+
15+
Assert.Throws<ArgumentException>(()=>RpcVersion.Parse("cats"));
16+
Assert.Throws<ArgumentException>(()=>RpcVersion.Parse("cats.dogs"));
17+
Assert.Throws<ArgumentException>(()=>RpcVersion.Parse("1.dogs"));
18+
Assert.Throws<ArgumentException>(()=>RpcVersion.Parse("1.0.1"));
19+
Assert.Throws<ArgumentException>(()=>RpcVersion.Parse("11"));
20+
}
21+
22+
privatevoidIsCompatibleWithBothWays(RpcVersiona,RpcVersionb,IResolveConstraintc)
23+
{
24+
Assert.That(a.IsCompatibleWith(b),c);
25+
Assert.That(b.IsCompatibleWith(a),c);
26+
}
27+
28+
[Test(Description="Test that versions are compatible")]
29+
publicvoidIsCompatibleWith()
30+
{
31+
vartwoOne=newRpcVersion(2,1);
32+
Assert.That(twoOne.IsCompatibleWith(twoOne),Is.EqualTo(twoOne));
33+
34+
// 2.1 && 2.2 => 2.1
35+
IsCompatibleWithBothWays(twoOne,newRpcVersion(2,2),Is.EqualTo(newRpcVersion(2,1)));
36+
// 2.1 && 2.0 => 2.0
37+
IsCompatibleWithBothWays(twoOne,newRpcVersion(2,0),Is.EqualTo(newRpcVersion(2,0)));
38+
// 2.1 && 3.1 => null
39+
IsCompatibleWithBothWays(twoOne,newRpcVersion(3,1),Is.Null);
40+
// 2.1 && 1.1 => null
41+
IsCompatibleWithBothWays(twoOne,newRpcVersion(1,1),Is.Null);
42+
}
43+
}
44+
45+
[TestFixture]
46+
publicclassRpcVersionListTest
47+
{
48+
[Test(Description="Parse a variety of version list strings")]
49+
publicvoidParse()
50+
{
51+
Assert.That(RpcVersionList.Parse("1.0"),Is.EqualTo(newRpcVersionList(newRpcVersion(1,0))));
52+
Assert.That(RpcVersionList.Parse("1.3,2.1"),
53+
Is.EqualTo(newRpcVersionList(newRpcVersion(1,3),newRpcVersion(2,1))));
54+
55+
varex=Assert.Throws<ArgumentException>(()=>RpcVersionList.Parse("0.1"));
56+
Assert.That(ex.InnerException,Is.Not.Null);
57+
Assert.That(ex.InnerException.Message,Does.Contain("Invalid major version"));
58+
ex=Assert.Throws<ArgumentException>(()=>RpcVersionList.Parse(""));
59+
Assert.That(ex.InnerException,Is.Not.Null);
60+
Assert.That(ex.InnerException.Message,Does.Contain("Invalid version string"));
61+
ex=Assert.Throws<ArgumentException>(()=>RpcVersionList.Parse("2.1,1.1"));
62+
Assert.That(ex.InnerException,Is.Not.Null);
63+
Assert.That(ex.InnerException.Message,Does.Contain("sorted"));
64+
ex=Assert.Throws<ArgumentException>(()=>RpcVersionList.Parse("1.1,1.2"));
65+
Assert.That(ex.InnerException,Is.Not.Null);
66+
Assert.That(ex.InnerException.Message,Does.Contain("Duplicate major version"));
67+
}
68+
69+
[Test(Description="Validate a variety of version lists to test every error")]
70+
publicvoidValidate()
71+
{
72+
Assert.DoesNotThrow(()=>
73+
newRpcVersionList(newRpcVersion(1,3),newRpcVersion(2,4),newRpcVersion(3,0)).Validate());
74+
75+
varex=Assert.Throws<ArgumentException>(()=>newRpcVersionList(newRpcVersion(0,1)).Validate());
76+
Assert.That(ex.Message,Does.Contain("Invalid major version"));
77+
ex=Assert.Throws<ArgumentException>(()=>
78+
newRpcVersionList(newRpcVersion(2,1),newRpcVersion(1,2)).Validate());
79+
Assert.That(ex.Message,Does.Contain("sorted"));
80+
ex=Assert.Throws<ArgumentException>(()=>
81+
newRpcVersionList(newRpcVersion(1,1),newRpcVersion(1,2)).Validate());
82+
Assert.That(ex.Message,Does.Contain("Duplicate major version"));
83+
}
84+
85+
privatevoidIsCompatibleWithBothWays(RpcVersionLista,RpcVersionListb,IResolveConstraintc)
86+
{
87+
Assert.That(a.IsCompatibleWith(b),c);
88+
Assert.That(b.IsCompatibleWith(a),c);
89+
}
90+
91+
[Test(Description="Check a variety of lists against each other to determine compatible version")]
92+
publicvoidIsCompatibleWith()
93+
{
94+
varlist1=RpcVersionList.Parse("1.2,2.4,3.2");
95+
Assert.That(list1.IsCompatibleWith(list1),Is.EqualTo(newRpcVersion(3,2)));
96+
97+
IsCompatibleWithBothWays(list1,RpcVersionList.Parse("4.1,5.2"),Is.Null);
98+
IsCompatibleWithBothWays(list1,RpcVersionList.Parse("1.2,2.3"),Is.EqualTo(newRpcVersion(2,3)));
99+
IsCompatibleWithBothWays(list1,RpcVersionList.Parse("2.3,3.3"),Is.EqualTo(newRpcVersion(3,2)));
100+
}
101+
}

‎Tests/Vpn/SpeakerTest.cs

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
usingSystem.Buffers;
22
usingSystem.IO.Pipelines;
33
usingSystem.Reflection;
4+
usingSystem.Text;
45
usingSystem.Threading.Channels;
56
usingCoder.Desktop.Vpn;
67
usingCoder.Desktop.Vpn.Proto;
@@ -277,6 +278,45 @@ public async Task ReadLargeHeader()
277278
Assert.That(gotEx.Message,Does.Contain("Header malformed or too large"));
278279
}
279280

281+
[Test(Description="Receive an invalid header")]
282+
[Timeout(30_000)]
283+
publicasyncTaskReceiveInvalidHeader()
284+
{
285+
varcases=newDictionary<string,(string,string?)>
286+
{
287+
{"invalid\n",("Failed to parse peer header","Wrong number of parts in header string")},
288+
{"cats tunnel 1.0\n",("Failed to parse peer header","Invalid preamble in header string")},
289+
{"codervpn cats 1.0\n",("Failed to parse peer header","Unknown role 'cats'")},
290+
{"codervpn manager 1.0\n",("Expected peer role 'tunnel' but got 'manager'",null)},
291+
{
292+
"codervpn tunnel 1000.1\n",
293+
($"No RPC versions are compatible: local={RpcVersionList.Current}, remote=1000.1",null)
294+
},
295+
{"codervpn tunnel 0.1\n",("Failed to parse peer header","Invalid version list '0.1'")},
296+
{"codervpn tunnel 1.0,1.2\n",("Failed to parse peer header","Invalid version list '1.0,1.2'")},
297+
{"codervpn tunnel 2.0,3.1,1.2\n",("Failed to parse peer header","Invalid version list '2.0,3.1,1.2'")},
298+
};
299+
300+
foreach(var(header,(expectedOuter,expectedInner))incases)
301+
{
302+
var(stream1,stream2)=BidirectionalPipe.New();
303+
awaitusingvarspeaker1=newSpeaker<ManagerMessage,TunnelMessage>(stream1);
304+
305+
awaitstream2.WriteAsync(Encoding.UTF8.GetBytes(header));
306+
307+
vargotEx=Assert.CatchAsync(()=>speaker1.StartAsync(),$"header: '{header}'");
308+
Assert.That(gotEx.Message,Does.Contain(expectedOuter),$"header: '{header}'");
309+
if(expectedInnerisnull)
310+
{
311+
Assert.That(gotEx.InnerException,Is.Null,$"header: '{header}'");
312+
continue;
313+
}
314+
315+
Assert.That(gotEx.InnerException,Is.Not.Null,$"header: '{header}'");
316+
Assert.That(gotEx.InnerException!.Message,Does.Contain(expectedInner),$"header: '{header}'");
317+
}
318+
}
319+
280320
[Test(Description="Encounter a write error during message send")]
281321
[Timeout(30_000)]
282322
publicasyncTaskSendMessageWriteError()

‎Vpn.Proto/ApiVersion.cs

Lines changed: 0 additions & 103 deletions
This file was deleted.

‎Vpn.Proto/RpcHeader.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ namespace Coder.Desktop.Vpn.Proto;
66
/// A header to write or read from a stream to identify the speaker's role and version.
77
/// </summary>
88
/// <param name="role">Role of the speaker</param>
9-
/// <param name="version">Version of the speaker</param>
10-
publicclassRpcHeader(RpcRolerole,ApiVersionversion)
9+
/// <param name="versionList">Version of the speaker</param>
10+
publicclassRpcHeader(RpcRolerole,RpcVersionListversionList)
1111
{
1212
privateconststringPreamble="codervpn";
1313

1414
publicRpcRoleRole{get;}=role;
15-
publicApiVersionVersion{get;}=version;
15+
publicRpcVersionListVersionList{get;}=versionList;
1616

1717
/// <summary>
1818
/// Parse a header string into a <c>SpeakerHeader</c>.
@@ -26,17 +26,17 @@ public static RpcHeader Parse(string header)
2626
if(parts.Length!=3)thrownewArgumentException($"Wrong number of parts in header string '{header}'");
2727
if(parts[0]!=Preamble)thrownewArgumentException($"Invalid preamble in header string '{header}'");
2828

29-
varversion=ApiVersion.Parse(parts[1]);
30-
varrole=newRpcRole(parts[2]);
31-
returnnewRpcHeader(role,version);
29+
varrole=newRpcRole(parts[1]);
30+
varversionList=RpcVersionList.Parse(parts[2]);
31+
returnnewRpcHeader(role,versionList);
3232
}
3333

3434
/// <summary>
3535
/// Construct a header string from the role and version with a trailing newline.
3636
/// </summary>
3737
publicoverridestringToString()
3838
{
39-
return$"{Preamble}{Version}{Role}\n";
39+
return$"{Preamble}{Role}{VersionList}\n";
4040
}
4141

4242
publicReadOnlyMemory<byte>ToBytes()

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp