Improve unit tests (#108)

***NO_CI***
nanoframework · Jul 31, 2024 · 99c68d1 · 99c68d1
1 parent aaf1815
commit 99c68d1
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 39 deletions.
diff --git a/System.IO.FileSystem.UnitTests/DirectoryUnitTests.cs b/System.IO.FileSystem.UnitTests/DirectoryUnitTests.cs
@@ -13,7 +13,9 @@ public class DirectoryUnitTests : FileSystemUnitTestsBase
         [Setup]
         public void Setup()
         {
-            Assert.SkipTest("These test will only run on real hardware. Comment out this line if you are testing on real hardware.");
+            // setting these to false assuming that the SD card is already mounted
+            WaitForRemovableDrive = false;
+            ConfigAndMountSdCard = false;
 
             RemovableDrivesHelper();
         }

diff --git a/System.IO.FileSystem.UnitTests/FileSystemUnitTestsBase.cs b/System.IO.FileSystem.UnitTests/FileSystemUnitTestsBase.cs
@@ -25,31 +25,12 @@ public abstract class FileSystemUnitTestsBase
         // I: and J: internal flash
         internal const string Root = @"I:\";
 
-        // set to true to wait for removable drive(s) to be mounted
-        internal const bool _waitForRemovableDrive = false;
+        public static bool WaitForRemovableDrive { get; set; } = false;
 
-        // set to true to have SPI SD card mounted
-        internal const bool _configAndMountSdCard = false;
+        public static bool ConfigAndMountSdCard { get; set; } = false;
 
         //////////////////////////////////////////////////
 
-        private SDCard _mycardBacking;
-
-        internal SDCard MyCard
-        {
-            set
-            {
-                _mycardBacking = value;
-            }
-
-            get
-            {
-                _mycardBacking ??= InitializeSDCard();
-
-                return _mycardBacking;
-            }
-        }
-
         /// <summary>
         /// Initializes the SD card. Can be overridden in the derived class to provide specific initialization.
         /// </summary>
@@ -72,34 +53,45 @@ protected SDCard InitializeSDCard()
         /// </summary>
         internal void RemovableDrivesHelper()
         {
-            if (_configAndMountSdCard)
+            if (ConfigAndMountSdCard)
             {
             TryToMountAgain:
 
                 try
                 {
-                    MyCard.Mount();
+                    SDCard card = InitializeSDCard();
+                    card.Mount();
                 }
                 catch (Exception ex)
                 {
                     OutputHelper.WriteLine($"SDCard mount failed: {ex.Message}");
 
                     Thread.Sleep(TimeSpan.FromSeconds(2));
 
-                    MyCard = null;
-
                     goto TryToMountAgain;
                 }
             }
+            else
+            {
+                OutputHelper.WriteLine("***************************************");
+                OutputHelper.WriteLine("*** Skipping SD card initialization ***");
+                OutputHelper.WriteLine("***************************************");
+            }
 
-            if (_waitForRemovableDrive)
+            if (WaitForRemovableDrive)
             {
                 // wait until all removable drives are mounted
                 while (DriveInfo.GetDrives().Length < _numberOfDrives)
                 {
                     Thread.Sleep(1000);
                 }
             }
+            else
+            {
+                OutputHelper.WriteLine("******************************************");
+                OutputHelper.WriteLine("*** Skipping wait for removable drives ***");
+                OutputHelper.WriteLine("******************************************");
+            }
         }
     }
 }
diff --git a/System.IO.FileSystem.UnitTests/FileUnitTests.cs b/System.IO.FileSystem.UnitTests/FileUnitTests.cs
@@ -21,7 +21,9 @@ public class FileUnitTests : FileSystemUnitTestsBase
         [Setup]
         public void Setup()
         {
-            Assert.SkipTest("These test will only run on real hardware. Comment out this line if you are testing on real hardware.");
+            // setting these to false assuming that the SD card is already mounted
+            WaitForRemovableDrive = false;
+            ConfigAndMountSdCard = false;
 
             RemovableDrivesHelper();
         }
@@ -112,9 +114,9 @@ private static void CreateFile(string path, string content)
         {
             OutputHelper.WriteLine($"Creating file: {path}...");
 
-            CreateFile(
+            File.AppendAllText(
                 path,
-                Encoding.UTF8.GetBytes(content));
+                content);
         }
 
         private static void DeleteFile(string path)
@@ -359,15 +361,17 @@ public void Create_creates_file()
             ExecuteTestAndTearDown(() =>
             {
                 OutputHelper.WriteLine($"Creating file {Destination} WITHOUT content...");
-                using var stream = File.Create(Destination);
+                File.AppendAllText(
+                    Destination,
+                    string.Empty);
 
                 Console.WriteLine("Checking it file exists...");
                 AssertFileExists(Destination);
 
                 Console.WriteLine("Checking file content...");
                 AssertContentEquals(
-                    stream,
-                    EmptyContent);
+                    Destination,
+                    string.Empty);
             });
 
             ExecuteTestAndTearDown(() =>
@@ -378,14 +382,16 @@ public void Create_creates_file()
                     new byte[100]);
 
                 Console.WriteLine("Creating file and truncating it...");
-                using var stream = File.Create(Destination);
+                File.WriteAllBytes(
+                    Destination,
+                    EmptyContent);
 
                 Console.WriteLine("Checking it file exists...");
                 AssertFileExists(Destination);
 
                 Console.WriteLine("Checking file content...");
                 AssertContentEquals(
-                    stream,
+                    Destination,
                     EmptyContent);
             });
         }

diff --git a/System.IO.FileSystem.UnitTests/PathUnitTests.cs b/System.IO.FileSystem.UnitTests/PathUnitTests.cs
@@ -13,7 +13,9 @@ public class PathUnitTests : FileSystemUnitTestsBase
         [Setup]
         public void Setup()
         {
-            Assert.SkipTest("These test will only run on real hardware. Comment out this line if you are testing on real hardware.");
+            // setting these to false assuming that the SD card is already mounted
+            WaitForRemovableDrive = false;
+            ConfigAndMountSdCard = false;
 
             RemovableDrivesHelper();
         }

diff --git a/System.IO.FileSystem.UnitTests/nano.runsettings b/System.IO.FileSystem.UnitTests/nano.runsettings
@@ -3,14 +3,14 @@
    <!-- Configurations that affect the Test Framework -->
    <RunConfiguration>
        <ResultsDirectory>.\TestResults</ResultsDirectory><!-- Path relative to solution directory -->
-       <TestSessionTimeout>120000</TestSessionTimeout><!-- Milliseconds -->
+       <TestSessionTimeout>60000</TestSessionTimeout><!-- Milliseconds -->
        <TargetFrameworkVersion>net48</TargetFrameworkVersion>
        <TargetPlatform>x64</TargetPlatform>
    </RunConfiguration>
    <nanoFrameworkAdapter>
-       <Logging>None</Logging> <!--Set to the desired level of logging for Unit Test execution. Possible values are: None, Detailed, Verbose, Error. -->
-       <IsRealHardware>True</IsRealHardware><!--Set to true to run tests on real hardware. -->
        <RealHardwarePort>COM3</RealHardwarePort><!--Specify the COM port to use to connect to a nanoDevice. If none is specified, a device detection is performed and the 1st available one will be used. -->
+       <Logging>Verbose</Logging> <!--Set to the desired level of logging for Unit Test execution. Possible values are: None, Detailed, Verbose, Error. -->
+       <IsRealHardware>False</IsRealHardware><!--Set to true to run tests on real hardware. -->
        <CLRVersion></CLRVersion><!--Specify the nanoCLR version to use. If not specified, the latest available will be used. -->
        <PathToLocalCLRInstance></PathToLocalCLRInstance><!--Specify the path to a local nanoCLR instance. If not specified, the default one installed with nanoclr CLR witll be used. -->
    </nanoFrameworkAdapter>

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -59,6 +59,8 @@ steps:
 - template: azure-pipelines-templates/class-lib-build.yml@templates
   parameters:
     sonarCloudProject: 'nanoframework_lib-System.IO.FileSystem'
+    runUnitTests: true
+    unitTestRunsettings: '$(System.DefaultWorkingDirectory)\System.IO.FileSystem.UnitTests\nano.runsettings'
 
 # update dependents
 - template: azure-pipelines-templates/update-dependents.yml@templates