Skip to content

Commit 33d27aa

Browse files
zeusongitzeusongit
authored
DYN-7413 Add release notes URL and compatibility matrix properties to Package Version Header (#111)
* add release notes and compatibility matrix properties * Update GregClientTests.cs * update test
1 parent 1f722dd commit 33d27aa

File tree

2 files changed

+57
-5
lines changed

2 files changed

+57
-5
lines changed

‎src/GregClient/Requests/PackageVersionUploadRequestBody.cs‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,55 @@ public PackageVersionUploadRequestBody()
1212

1313
}
1414

15+
/// <summary>
16+
/// Constructor which can be used to set hostDependencies
17+
/// </summary>
18+
/// <param name="name">Package name</param>
19+
/// <param name="version">Package version</param>
20+
/// <param name="description">Package description</param>
21+
/// <param name="keywords">Package keywords for quick identification</param>
22+
/// <param name="contents">Package content description</param>
23+
/// <param name="engine">Package engine name, usually is set to Dynamo</param>
24+
/// <param name="engineVersion">Package engine version, usually is set to use Dynamo version</param>
25+
/// <param name="metadata"></param>
26+
/// <param name="group"></param>
27+
/// <param name="dependencies">Package dependencies</param>
28+
/// <param name="siteUrl"></param>
29+
/// <param name="repositoryUrl"></param>
30+
/// <param name="containsBinaries">boolean flag indicating if the package contains binaries</param>
31+
/// <param name="nodeLibraryNames"></param>
32+
/// <param name="hostDependencies"> external programs this package depends on.</param
33+
/// <param name="copyright_holder">Copyright Holder's name</param>
34+
/// <param name="copyright_year">Year the copyright was put into effect.</param>
35+
public PackageVersionUploadRequestBody(string name, string version, string description,
36+
IEnumerable<string> keywords,
37+
string contents, string engine, string engineVersion,
38+
string metadata, string group, IEnumerable<PackageDependency> dependencies,
39+
string siteUrl, string repositoryUrl, bool containsBinaries,
40+
IEnumerable<string> nodeLibraryNames, IEnumerable<string> hostDependencies,
41+
string copyright_holder, string copyright_year, string compatibility_matrix, string releaseNotesUrl)
42+
43+
{
44+
this.host_dependencies = hostDependencies;
45+
this.copyright_holder = copyright_holder;
46+
this.copyright_year = copyright_year;
47+
this.name = name;
48+
this.version = version;
49+
this.description = description;
50+
this.dependencies = dependencies;
51+
this.keywords = keywords;
52+
this.contents = contents;
53+
this.engine = engine;
54+
this.group = group;
55+
this.engine_version = engineVersion;
56+
this.engine_metadata = metadata;
57+
this.site_url = siteUrl;
58+
this.repository_url = repositoryUrl;
59+
this.contains_binaries = containsBinaries;
60+
this.node_libraries = nodeLibraryNames;
61+
this.compatibility_matrix = compatibility_matrix;
62+
this.releaseNotesUrl = releaseNotesUrl;
63+
}
1564

1665
/// <summary>
1766
/// Constructor which can be used to set hostDependencies
@@ -33,6 +82,7 @@ public PackageVersionUploadRequestBody()
3382
/// <param name="hostDependencies"> external programs this package depends on.</param
3483
/// <param name="copyright_holder">Copyright Holder's name</param>
3584
/// <param name="copyright_year">Year the copyright was put into effect.</param>
85+
[Obsolete("This constructor may not initiate all the properties and will be removed in a future release of PackageManagerClient.")]
3686
public PackageVersionUploadRequestBody(string name, string version, string description,
3787
IEnumerable<string> keywords,
3888
string contents, string engine, string engineVersion,
@@ -82,5 +132,7 @@ public PackageVersionUploadRequestBody(string name, string version, string descr
82132
public IEnumerable<string> node_libraries { get; set; }
83133
public string copyright_holder { get; set; }
84134
public string copyright_year { get; set; }
135+
public string compatibility_matrix { get; set; }
136+
public string releaseNotesUrl { get; set; }
85137
}
86138
}

‎src/GregClientTests/GregClientTests.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ public void UploadDynamoPackageVersionTest()
5656
var keywords = new List<string>() { "neat", "ok" };
5757
var nv = new PackageVersionUploadRequestBody("Third .NET Package", "2.1.0", "", keywords, "contents", "dynamo", "0.1.0", "metadata", "group",
5858
new List<PackageDependency>() { new PackageDependency("peter", "0.1.0"), new PackageDependency("stephen", "0.1.0") }, "", "",
59-
false, new List<String>(), new List<String>(), "Dynamo Team", "2021");
59+
false, new List<String>(), new List<String>(), "Dynamo Team", "2021","","");
6060

6161
var files = new List<string>() { "../test/pedro.dyf", "../test/RootNode.dyf" };
6262
var request = new PackageVersionUpload(nv, files);
63-
Assert.That(request.RequestBody.AsJson().Equals("{\"file_hash\":null,\"name\":\"Third .NET Package\",\"version\":\"2.1.0\",\"description\":\"\",\"group\":\"group\",\"keywords\":[\"neat\",\"ok\"],\"dependencies\":[{\"name\":\"peter\",\"version\":\"0.1.0\"},{\"name\":\"stephen\",\"version\":\"0.1.0\"}],\"host_dependencies\":[],\"contents\":\"contents\",\"engine_version\":\"0.1.0\",\"engine\":\"dynamo\",\"engine_metadata\":\"metadata\",\"site_url\":\"\",\"repository_url\":\"\",\"contains_binaries\":false,\"node_libraries\":[],\"copyright_holder\":\"Dynamo Team\",\"copyright_year\":\"2021\"}"));
63+
Assert.That(request.RequestBody.AsJson().Equals("{\"file_hash\":null,\"name\":\"Third .NET Package\",\"version\":\"2.1.0\",\"description\":\"\",\"group\":\"group\",\"keywords\":[\"neat\",\"ok\"],\"dependencies\":[{\"name\":\"peter\",\"version\":\"0.1.0\"},{\"name\":\"stephen\",\"version\":\"0.1.0\"}],\"host_dependencies\":[],\"contents\":\"contents\",\"engine_version\":\"0.1.0\",\"engine\":\"dynamo\",\"engine_metadata\":\"metadata\",\"site_url\":\"\",\"repository_url\":\"\",\"contains_binaries\":false,\"node_libraries\":[],\"copyright_holder\":\"Dynamo Team\",\"copyright_year\":\"2021\",\"compatibility_matrix\":\"\",\"releaseNotesUrl\":\"\"}"));
6464
Console.WriteLine(request.RequestBody.AsJson());
6565
}
6666

@@ -70,11 +70,11 @@ public void UploadDynamoPackageWithHostDependencyTest()
7070
var keywords = new List<string>() { "Civil" };
7171
var nv = new PackageVersionUploadRequestBody("Third .NET Package", "2.1.0", "", keywords, "contents", "dynamo", "0.1.0", "metadata", "group",
7272
new List<PackageDependency>() { new PackageDependency("Ram", "0.1.0"), new PackageDependency("Ian", "0.1.0") }, "", "",
73-
false, new List<String>(), new List<String>() { "Civil3D" }, "Dynamo Team", "2021");
73+
false, new List<String>(), new List<String>() { "Civil3D" }, "Dynamo Team", "2021", "", "");
7474

7575
var files = new List<string>() { "../test/pedro.dyf", "../test/RootNode.dyf" };
7676
var request = new PackageVersionUpload(nv, files);
77-
Assert.That(request.RequestBody.AsJson().Equals("{\"file_hash\":null,\"name\":\"Third .NET Package\",\"version\":\"2.1.0\",\"description\":\"\",\"group\":\"group\",\"keywords\":[\"Civil\"],\"dependencies\":[{\"name\":\"Ram\",\"version\":\"0.1.0\"},{\"name\":\"Ian\",\"version\":\"0.1.0\"}],\"host_dependencies\":[\"Civil3D\"],\"contents\":\"contents\",\"engine_version\":\"0.1.0\",\"engine\":\"dynamo\",\"engine_metadata\":\"metadata\",\"site_url\":\"\",\"repository_url\":\"\",\"contains_binaries\":false,\"node_libraries\":[],\"copyright_holder\":\"Dynamo Team\",\"copyright_year\":\"2021\"}"));
77+
Assert.That(request.RequestBody.AsJson().Equals("{\"file_hash\":null,\"name\":\"Third .NET Package\",\"version\":\"2.1.0\",\"description\":\"\",\"group\":\"group\",\"keywords\":[\"Civil\"],\"dependencies\":[{\"name\":\"Ram\",\"version\":\"0.1.0\"},{\"name\":\"Ian\",\"version\":\"0.1.0\"}],\"host_dependencies\":[\"Civil3D\"],\"contents\":\"contents\",\"engine_version\":\"0.1.0\",\"engine\":\"dynamo\",\"engine_metadata\":\"metadata\",\"site_url\":\"\",\"repository_url\":\"\",\"contains_binaries\":false,\"node_libraries\":[],\"copyright_holder\":\"Dynamo Team\",\"copyright_year\":\"2021\",\"compatibility_matrix\":\"\",\"releaseNotesUrl\":\"\"}"));
7878
Console.WriteLine(request.RequestBody.AsJson());
7979
}
8080

@@ -83,7 +83,7 @@ public void UploadDynamoPackageVersionWithFilesTest()
8383
{
8484
var keywords = new List<string>() { "neat", "ok" };
8585
var nv = new PackageVersionUploadRequestBody("Third .NET Package", "2.1.0", "", keywords, "contents", "dynamo", "0.1.0", "metadata", "group",
86-
new List<PackageDependency>() { new PackageDependency("peter", "0.1.0"), new PackageDependency("stephen", "0.1.0") }, "", "", false, new List<String>(), new List<String>(), "", "");
86+
new List<PackageDependency>() { new PackageDependency("peter", "0.1.0"), new PackageDependency("stephen", "0.1.0") }, "", "", false, new List<String>(), new List<String>(), "", "", "", "");
8787

8888
var files = new List<string>() {Assembly.GetExecutingAssembly().Location };
8989

0 commit comments

Comments
 (0)