Integration test framework (#49)

* Introduce integration test framework
* Improve configuration of OVS database connections
* Improve validation of command execution results

+semver: major

Author: ChristopherMann

.gitattributes

@@ -3,6 +3,14 @@
 ###############################################################################
 * text=auto
 
+###############################################################################
+# Recommended setings for Verify.
+###############################################################################
+*.verified.txt text eol=lf working-tree-encoding=UTF-8
+*.verified.xml text eol=lf working-tree-encoding=UTF-8
+*.verified.json text eol=lf working-tree-encoding=UTF-8
+*.verified.bin binary
+
 ###############################################################################
 # Set default behavior for command prompt diff.
 #

.gitignore

@@ -261,4 +261,7 @@ __pycache__/
 *.pyc
 
 
-.idea
+.idea
+
+# Verify results
+*.received.*

OVNAgent.sln

@@ -23,6 +23,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OVNAgent", "src\OVNAgent\OV
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OVN.Windows", "src\OVN.Windows\OVN.Windows.csproj", "{19E88AFC-25A8-45A2-8F45-FD5A4BC9883B}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OVN.Core.IntegrationTests", "test\OVN.Core.IntegrationTests\OVN.Core.IntegrationTests.csproj", "{AFB92E98-3FAD-4EE5-B154-336E9715EABA}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -65,6 +67,10 @@ Global
 		{19E88AFC-25A8-45A2-8F45-FD5A4BC9883B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{19E88AFC-25A8-45A2-8F45-FD5A4BC9883B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{19E88AFC-25A8-45A2-8F45-FD5A4BC9883B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{AFB92E98-3FAD-4EE5-B154-336E9715EABA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{AFB92E98-3FAD-4EE5-B154-336E9715EABA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{AFB92E98-3FAD-4EE5-B154-336E9715EABA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{AFB92E98-3FAD-4EE5-B154-336E9715EABA}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -73,6 +79,7 @@ Global
 		{C59D1A52-ED62-485C-8D53-D247E64AFDF8} = {F3C9BF77-FF83-4BE3-8E8F-06A0C65CF5D3}
 		{E765A6A4-ADE6-46E1-B1FC-BEBC362897F1} = {F3C9BF77-FF83-4BE3-8E8F-06A0C65CF5D3}
 		{A4AADA77-425D-4E63-816D-6FDC21A40A94} = {F3C9BF77-FF83-4BE3-8E8F-06A0C65CF5D3}
+		{AFB92E98-3FAD-4EE5-B154-336E9715EABA} = {F3C9BF77-FF83-4BE3-8E8F-06A0C65CF5D3}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {0FDDB177-FC3D-4D1E-BE62-EEF24847FB47}

azure-piplines.yml

@@ -30,6 +30,20 @@ steps:
     projects: '**/*.csproj'
     arguments: '--configuration $(buildConfiguration)'
 
+- task: PowerShell@2
+  displayName: Install OVS
+  condition: true
+  inputs:
+    pwsh: true
+    targetType: 'inline'
+    script: |
+      # Expand-Archive is a script module and will take its preferences from the global scope.
+      # See https://github.com/PowerShell/Microsoft.PowerShell.Archive/issues/77#issuecomment-601947496
+      $global:ProgressPreference = 'SilentlyContinue'
+      
+      Invoke-WebRequest -Uri 'https://github.com/eryph-org/eryph/raw/refs/heads/main/ovspackage-3.5.0-exp.zip' -OutFile C:\ovspackage.zip -UseBasicParsing
+      Expand-Archive -Path C:\ovspackage.zip -DestinationPath C:\openvswitch\usr
+
 - task: DotNetCoreCLI@2
   displayName: dotnet test
   inputs:

gitversion.yml

@@ -4,3 +4,4 @@ branches: {}
 ignore:
   sha: []
 merge-message-formats: {}
+next-version: 1.0.0

src/OVN.Abstractions/IGuidGenerator.cs

@@ -0,0 +1,13 @@
+namespace Dbosoft.OVN;
+
+/// <summary>
+/// Defines a generator which can be used to generate the
+/// UUIDs for new OVS database records.
+/// </summary>
+public interface IGuidGenerator
+{
+    /// <summary>
+    /// Returns a new <see cref="Guid"/>.
+    /// </summary>
+    Guid GenerateGuid();
+}

src/OVN.Abstractions/ISystemEnvironment.cs

@@ -30,4 +30,9 @@ public interface ISystemEnvironment
     /// to check the availability of the OVS kernel extensions.
     /// </summary>
     IOvsExtensionManager GetOvsExtensionManager();
+
+    /// <summary>
+    /// Returns a generator which can be used to generate <see cref="Guid"/>s.
+    /// </summary>
+    IGuidGenerator GuidGenerator { get; }
 }

src/OVN.Abstractions/OSCommands/IProcess.cs

@@ -33,7 +33,17 @@ public interface IProcess : IDisposable
     /// See <see cref="Process.HasExited"/>
     /// </summary>
     bool HasExited { get; }
-    
+
+    /// <summary>
+    /// See <see cref="Process.StandardOutput"/>
+    /// </summary>
+    StreamReader StandardOutput { get; }
+
+    /// <summary>
+    /// See <see cref="Process.StandardError"/>
+    /// </summary>
+    StreamReader StandardError { get; }
+
     /// <summary>
     /// See <see cref="Process.OutputDataReceived"/>
     /// </summary>

src/OVN.Core/DefaultFileSystem.cs

@@ -31,7 +31,7 @@ public string ResolveOvsFilePath(OvsFile file, bool platformNeutral = true)
     {
         var basePath = "";
         var pathRoot = file.Path.Split('/', StringSplitOptions.RemoveEmptyEntries);
-        basePath = FindBasePath(pathRoot.Length == 0
+        basePath = ResolveBasePath(pathRoot.Length == 0
             ? file.Path
             : pathRoot[0]);
 
@@ -89,17 +89,18 @@ private string ConvertPathToPlatform(string inputPath)
         return inputPath;
     }
 
-    protected virtual string FindBasePath(string pathRoot)
+    private string ResolveBasePath(string pathRoot)
     {
-        var basePath = "/";
-        if (_platform != OSPlatform.Windows) return $"{basePath}{pathRoot}";
-
-        if (pathRoot.StartsWith("usr"))
-            basePath = "c:/openvswitch/";
-        else
-            basePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData),
-                "openvswitch").Replace("\\", "/") + "/";
-        
-        return $"{basePath}{pathRoot}";
+        return pathRoot.StartsWith("usr")
+            ? $"{GetProgramRootPath()}{pathRoot}"
+            : $"{GetDataRootPath()}{pathRoot}";
     }
-}
+
+    protected virtual string GetDataRootPath() =>
+        _platform == OSPlatform.Windows
+            ? Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), "openvswitch").Replace(@"\", "/") + "/"
+            : "/";
+
+    protected virtual string GetProgramRootPath() =>
+        _platform == OSPlatform.Windows ? "C:/openvswitch/" : "/";
+}

src/OVN.Core/LocalConnections.cs

@@ -0,0 +1,10 @@
+namespace Dbosoft.OVN;
+
+public static class LocalConnections
+{
+    public static readonly OvsDbConnection Northbound = new(new OvsFile("/var/run/ovn", "ovnnb_db.sock"));
+
+    public static readonly OvsDbConnection Southbound = new(new OvsFile("/var/run/ovn", "ovnsb_db.sock"));
+
+    public static readonly OvsDbConnection Switch = new(new OvsFile("/var/run/openvswitch", "db.sock"));
+}