Add property OS to VersionOptions in case a project is for a certain OS only (currently Mojang Bedrock only)

Author: tekgator

CHANGELOG.md

@@ -3,9 +3,15 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+
+## [1.4.5] - 2023-06-04
+
 ### Fixed
 - Mojang Bedrock versions are now sorted newest to oldest
 
+### Added
+- Add property OS to VersionOptions in case a project is for a certain OS only (currently Mojang Bedrock only)
+
 
 ## [1.4.4] - 2023-06-03
 

MinecraftJars.Core/Versions/IMinecraftVersion.cs

@@ -19,6 +19,11 @@ public interface IMinecraftVersion
     /// Indicates whether this version experimental 
     /// </summary>      
     bool IsSnapShot { get; }
+
+    /// <summary>
+    /// Indicates whether this version requires a specific operating system
+    /// </summary>      
+    VersionOs Os => VersionOs.None;
 
     /// <summary>
     /// Indicates TRUE in case the plugin needs to build the JAR file instead of providing download information

MinecraftJars.Core/Versions/VersionOptions.cs

@@ -13,6 +13,12 @@ public class VersionOptions
     /// Indicates to return snapshot / experimental / preview / beta / alpha builds as well 
     /// </summary>       
     public bool IncludeSnapshotBuilds { get; set; }
+
+    /// <summary>
+    /// Only return versions Valid for this system e.g. if Windows is specified all
+    /// versions with NONE or WINDOWS are returned 
+    /// </summary>       
+    public VersionOs VersionOs { get; set; } = VersionOs.None;
 
     /// <summary>
     /// Limit the amount of records returned by the plugin API. Useful if only

MinecraftJars.Core/Versions/VersionOs.cs

@@ -0,0 +1,8 @@
+namespace MinecraftJars.Core.Versions;
+
+public enum VersionOs
+{
+    None = 0,
+    Windows = 1,
+    Linux = 2
+}

MinecraftJars.Plugin/MinecraftJars.Plugin.Mojang/Models/MojangVersion.cs

@@ -8,7 +8,7 @@ public record MojangVersion(
     IMinecraftProject Project,
     string Version,
     bool IsSnapShot,
-    Os? Os = null) : IMinecraftVersion
+    VersionOs Os = VersionOs.None) : IMinecraftVersion
 {
     internal DateTime? ReleaseTime { get; init; }
     internal string DetailUrl { get; init; } = string.Empty;

MinecraftJars.Plugin/MinecraftJars.Plugin.Mojang/MojangVersionFactory.cs

@@ -89,7 +89,10 @@ where string.IsNullOrWhiteSpace(options.Version) || version.Equals(options.Versi
             let isPreview = !string.IsNullOrWhiteSpace(match.Groups["preview"].Value)
             where options.IncludeSnapshotBuilds || !isPreview
             let url = match.Value
-            let platform = match.Groups["platform"].Value.Equals("linux", StringComparison.OrdinalIgnoreCase) ? Os.Linux : Os.Windows
+            let platform = match.Groups["platform"].Value.Equals("linux", StringComparison.OrdinalIgnoreCase) 
+                ? VersionOs.Linux 
+                : VersionOs.Windows
+            where options.VersionOs == VersionOs.None || platform == options.VersionOs
             orderby version descending 
             select new MojangVersion(
                 Project: project, 

MinecraftJars.Plugin/MinecraftJars.Plugin.Mojang/Os.cs

@@ -1,5 +1,4 @@
 using MinecraftJars.Core.Versions;
-using MinecraftJars.Plugin.Mojang.Models;
 
 namespace MinecraftJars.Tests;
 
@@ -51,30 +50,59 @@ public async Task GetVersions_MaxRecordsMax(
     [TestCaseSource(nameof(Projects)), Order(4)]
     public async Task GetVersions_SpecificVersion(string projectName)
     {
+        
         var project = MinecraftJar.GetProjects().Single(p => p.Name.Equals(projectName));
-        var version = (await project.GetVersions()).First();
+        var platform = OperatingSystem.IsWindows() ? VersionOs.Windows : VersionOs.Linux;
+        
+        var version = (await project.GetVersions(new VersionOptions
+        {
+            VersionOs = platform
+        })).First();
+
         var versions = (await project.GetVersions(new VersionOptions
         {
-            Version = version.Version
+            Version = version.Version,
+            VersionOs = platform
         })).ToList();
 
-        var count = version is MojangVersion { Os: not null } ? 2 : 1; 
-
-        Assert.That(versions, Has.Count.EqualTo(count));
+        Assert.That(versions, Has.Count.EqualTo(1));
         Assert.That(versions.First(), Is.EqualTo(version));
 
         TestContext.Progress.WriteLine("{0}: Specific version {1} found", 
             nameof(GetVersions_SpecificVersion), version.Version);
     }  
 
+    [TestCase("Bedrock"), Order(5)]
+    public async Task GetVersions_SpecificOs(string projectName)
+    {
+        var project = MinecraftJar.GetProjects().Single(p => p.Name.Equals(projectName));
+
+        foreach (var versionOs in Enum.GetValues<VersionOs>().Where(e => e != VersionOs.None))
+        {
+            var versions = (await project.GetVersions(new VersionOptions
+            {
+                VersionOs = versionOs
+            })).ToList();
+            
+            Assert.Multiple(() =>
+            {
+                Assert.That(versions.Any(v => v.Os != versionOs), Is.False);
+                Assert.That(versions.Any(), Is.True);
+            });
+            
+            TestContext.Progress.WriteLine("{0}: Search for {1} successful, no other Os found", 
+                nameof(GetVersions_SpecificOs), versionOs);
+        }
+    }    
+    
     [TestCase("Vanilla")]
     [TestCase("Bedrock")]
     [TestCase("Fabric")]
     [TestCase("Pocketmine")]
     [TestCase("Spigot")]
     [TestCase("Paper")]
     [TestCase("Velocity")]
-    [Order(5)]
+    [Order(6)]
     public async Task GetVersions_ContainsSnapshot(string projectName)
     {
         var project = MinecraftJar.GetProjects().Single(p => p.Name.Equals(projectName));
@@ -97,7 +125,7 @@ public async Task GetVersions_ContainsSnapshot(string projectName)
     [TestCase("Spigot")]
     [TestCase("Paper")]
     [TestCase("Velocity")]
-    [Order(6)]
+    [Order(7)]
     public async Task GetVersions_ContainsNoSnapshot(string projectName)
     {
         var project = MinecraftJar.GetProjects().Single(p => p.Name.Equals(projectName));