File I/O Abstraction (Part I)

src/Bicep.Cli.IntegrationTests/JsonRpcCommandTests.cs

@@ -191,35 +191,36 @@ await RunServerTest(
     [TestMethod]
     public async Task GetFileReferences_returns_all_referenced_files()
     {
-        var fileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
-        {
-            ["/main.bicepparam"] = """
-using 'main.bicep'
-
-param foo = 'foo'
-""",
-            ["/main.bicep"] = """
-param foo string
-
-var test = loadTextContent('invalid.txt')
-var test2 = loadTextContent('valid.txt')
-""",
-            ["/valid.txt"] = """
-hello!
-""",
-            ["/bicepconfig.json"] = """
-{}
-""",
-        });
+        var fileSystem = new MockFileSystem(
+            new Dictionary<string, MockFileData>
+            {
+                ["/main.bicepparam"] = """
+                    using 'main.bicep'
+
+                    param foo = 'foo'
+                    """,
+                ["/main.bicep"] = """
+                    param foo string
+
+                    var test = loadTextContent('invalid.txt')
+                    var test2 = loadTextContent('valid.txt')
+                    """,
+                ["/valid.txt"] = """
+                    hello!
+                    """,
+                ["/bicepconfig.json"] = """
+                    {}
+                    """,
+            });
 
         await RunServerTest(
             services => services.WithFileSystem(fileSystem),
             async (client, token) =>
             {
                 var response = await client.GetFileReferences(new("/main.bicepparam"), token);
 
-                response.FilePaths.Should().Equal([
-                    "/bicepconfig.json",
+                response.FilePaths.Should().BeEquivalentTo([
+                    fileSystem.Path.GetFullPath("/bicepconfig.json"),
                     "/invalid.txt",
                     "/main.bicep",
                     "/main.bicepparam",

src/Bicep.Cli.IntegrationTests/packages.lock.json

@@ -1585,6 +1585,7 @@
           "Azure.Deployments.Templates": "[1.152.0, )",
           "Azure.Identity": "[1.13.1, )",
           "Azure.ResourceManager.Resources": "[1.9.0, )",
+          "Bicep.IO": "[1.0.0, )",
           "JsonPatch.Net": "[3.1.1, )",
           "JsonPath.Net": "[1.1.6, )",
           "Microsoft.Extensions.Configuration": "[8.0.0, )",
@@ -1674,6 +1675,12 @@
           "System.IO.Abstractions.TestingHelpers": "[21.0.29, )"
         }
       },
+      "bicep.io": {
+        "type": "Project",
+        "dependencies": {
+          "System.IO.Abstractions": "[21.0.29, )"
+        }
+      },
       "bicep.langserver": {
         "type": "Project",
         "dependencies": {

src/Bicep.Cli.UnitTests/packages.lock.json

@@ -1457,6 +1457,7 @@
           "Azure.Deployments.Templates": "[1.152.0, )",
           "Azure.Identity": "[1.13.1, )",
           "Azure.ResourceManager.Resources": "[1.9.0, )",
+          "Bicep.IO": "[1.0.0, )",
           "JsonPatch.Net": "[3.1.1, )",
           "JsonPath.Net": "[1.1.6, )",
           "Microsoft.Extensions.Configuration": "[8.0.0, )",
@@ -1507,6 +1508,12 @@
           "Sarif.Sdk": "[4.5.4, )",
           "StreamJsonRpc": "[2.19.27, )"
         }
+      },
+      "bicep.io": {
+        "type": "Project",
+        "dependencies": {
+          "System.IO.Abstractions": "[21.0.29, )"
+        }
       }
     },
     "net8.0/linux-arm64": {

src/Bicep.Cli/Helpers/ServiceCollectionExtensions.cs

@@ -16,9 +16,11 @@
 using Bicep.Core.TypeSystem.Providers;
 using Bicep.Core.Utils;
 using Bicep.Decompiler;
+using Bicep.IO.Abstraction;
+using Bicep.IO.FileSystem;
 using Microsoft.Extensions.DependencyInjection;
 using Environment = Bicep.Core.Utils.Environment;
-using IOFileSystem = System.IO.Abstractions.FileSystem;
+using LocalFileSystem = System.IO.Abstractions.FileSystem;
 
 namespace Bicep.Cli.Helpers;
 
@@ -67,7 +69,8 @@ public static IServiceCollection AddBicepCore(this IServiceCollection services)
         .AddSingleton<ITokenCredentialFactory, TokenCredentialFactory>()
         .AddSingleton<IFileResolver, FileResolver>()
         .AddSingleton<IEnvironment, Environment>()
-        .AddSingleton<IFileSystem, IOFileSystem>()
+        .AddSingleton<IFileSystem, LocalFileSystem>()
+        .AddSingleton<IFileExplorer, FileSystemFileExplorer>()
         .AddSingleton<IConfigurationManager, ConfigurationManager>()
         .AddSingleton<IBicepAnalyzer, LinterAnalyzer>()
         .AddSingleton<IFeatureProviderFactory, FeatureProviderFactory>()

src/Bicep.Cli/Rpc/CliJsonRpcServer.cs

@@ -98,9 +98,16 @@ public async Task<GetFileReferencesResponse> GetFileReferences(GetFileReferences
         {
             fileUris.Add(otherModel.SourceFile.FileUri);
             fileUris.UnionWith(otherModel.GetAuxiliaryFileReferences());
-            if (otherModel.Configuration.ConfigFileUri is { } configFileUri)
+            if (otherModel.Configuration.ConfigFileIdentifier is { } configFileIdentifier)
             {
-                fileUris.Add(configFileUri);
+                var uri = new UriBuilder
+                {
+                    Scheme = configFileIdentifier.Scheme,
+                    Host = configFileIdentifier.Authority,
+                    Path = configFileIdentifier.Path,
+                }.Uri;
+
+                fileUris.Add(uri);
             }
         }
 

src/Bicep.Cli/packages.lock.json

@@ -1354,6 +1354,7 @@
           "Azure.Deployments.Templates": "[1.152.0, )",
           "Azure.Identity": "[1.13.1, )",
           "Azure.ResourceManager.Resources": "[1.9.0, )",
+          "Bicep.IO": "[1.0.0, )",
           "JsonPatch.Net": "[3.1.1, )",
           "JsonPath.Net": "[1.1.6, )",
           "Microsoft.Extensions.Configuration": "[8.0.0, )",
@@ -1393,6 +1394,12 @@
           "Google.Protobuf": "[3.28.3, )",
           "Grpc.Net.Client": "[2.66.0, )"
         }
+      },
+      "bicep.io": {
+        "type": "Project",
+        "dependencies": {
+          "System.IO.Abstractions": "[21.0.29, )"
+        }
       }
     },
     "net8.0/linux-arm64": {

src/Bicep.Core.IntegrationTests/ExtensionRegistryTests.cs

@@ -14,7 +14,7 @@
 using FluentAssertions.Execution;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Newtonsoft.Json.Linq;
-using IOFileSystem = System.IO.Abstractions.FileSystem;
+using LocalFileSystem = System.IO.Abstractions.FileSystem;
 
 namespace Bicep.Core.IntegrationTests;
 

src/Bicep.Core.IntegrationTests/packages.lock.json

@@ -1505,6 +1505,7 @@
           "Azure.Deployments.Templates": "[1.152.0, )",
           "Azure.Identity": "[1.13.1, )",
           "Azure.ResourceManager.Resources": "[1.9.0, )",
+          "Bicep.IO": "[1.0.0, )",
           "JsonPatch.Net": "[3.1.1, )",
           "JsonPath.Net": "[1.1.6, )",
           "Microsoft.Extensions.Configuration": "[8.0.0, )",
@@ -1573,6 +1574,12 @@
           "System.IO.Abstractions.TestingHelpers": "[21.0.29, )"
         }
       },
+      "bicep.io": {
+        "type": "Project",
+        "dependencies": {
+          "System.IO.Abstractions": "[21.0.29, )"
+        }
+      },
       "bicep.langserver": {
         "type": "Project",
         "dependencies": {

src/Bicep.Core.Samples/packages.lock.json

@@ -1505,6 +1505,7 @@
           "Azure.Deployments.Templates": "[1.152.0, )",
           "Azure.Identity": "[1.13.1, )",
           "Azure.ResourceManager.Resources": "[1.9.0, )",
+          "Bicep.IO": "[1.0.0, )",
           "JsonPatch.Net": "[3.1.1, )",
           "JsonPath.Net": "[1.1.6, )",
           "Microsoft.Extensions.Configuration": "[8.0.0, )",
@@ -1562,6 +1563,12 @@
           "System.IO.Abstractions.TestingHelpers": "[21.0.29, )"
         }
       },
+      "bicep.io": {
+        "type": "Project",
+        "dependencies": {
+          "System.IO.Abstractions": "[21.0.29, )"
+        }
+      },
       "bicep.langserver": {
         "type": "Project",
         "dependencies": {

src/Bicep.Core.UnitTests/BicepTestConstants.cs

@@ -3,6 +3,7 @@
 
 using System.Collections.Immutable;
 using System.IO.Abstractions;
+using System.IO.Abstractions.TestingHelpers;
 using Azure.Containers.ContainerRegistry;
 using Bicep.Core.Analyzers.Linter;
 using Bicep.Core.Analyzers.Linter.Rules;
@@ -22,10 +23,12 @@
 using Bicep.Core.UnitTests.Utils;
 using Bicep.Core.Utils;
 using Bicep.Core.Workspaces;
+using Bicep.IO.Abstraction;
+using Bicep.IO.FileSystem;
 using Bicep.LanguageServer.Registry;
 using Bicep.LanguageServer.Telemetry;
 using Moq;
-using IOFileSystem = System.IO.Abstractions.FileSystem;
+using OnDiskFileSystem = System.IO.Abstractions.FileSystem;
 
 namespace Bicep.Core.UnitTests
 {
@@ -37,9 +40,12 @@ public static class BicepTestConstants
 
         public const string GeneratorTemplateHashPath = "metadata._generator.templateHash";
 
-        public static readonly IFileSystem FileSystem = new IOFileSystem();
+        public static readonly IFileSystem FileSystem = new OnDiskFileSystem();
+
         public static readonly FileResolver FileResolver = new(FileSystem);
 
+        public static readonly IFileExplorer fileExplorer = new FileSystemFileExplorer(FileSystem);
+
         public static readonly FeatureProviderOverrides FeatureOverrides = new();
 
         public static readonly ConfigurationManager ConfigurationManager = CreateFilesystemConfigurationManager();
@@ -89,7 +95,7 @@ public static IModuleDispatcher CreateModuleDispatcher(IServiceProvider services
 
         public static readonly IModuleRestoreScheduler ModuleRestoreScheduler = CreateMockModuleRestoreScheduler();
 
-        public static RootConfiguration CreateMockConfiguration(Dictionary<string, object>? customConfigurationData = null, Uri? configFileUri = null)
+        public static RootConfiguration CreateMockConfiguration(Dictionary<string, object>? customConfigurationData = null, string? configFilePath = null)
         {
             var configurationData = new Dictionary<string, object>
             {
@@ -120,10 +126,12 @@ public static RootConfiguration CreateMockConfiguration(Dictionary<string, objec
                 element = element.SetPropertyByPath(path, value);
             }
 
-            return RootConfiguration.Bind(element, configFileUri);
+            ResourceIdentifier? configFileIdentifier = configFilePath is not null ? new ResourceIdentifier("file", "", configFilePath) : null;
+
+            return RootConfiguration.Bind(element, configFileIdentifier);
         }
 
-        public static ConfigurationManager CreateFilesystemConfigurationManager() => new(new IOFileSystem());
+        public static ConfigurationManager CreateFilesystemConfigurationManager() => new(new FileSystemFileExplorer(new OnDiskFileSystem()));
 
         public static IFeatureProviderFactory CreateFeatureProviderFactory(FeatureProviderOverrides featureOverrides, IConfigurationManager? configurationManager = null)
             => new OverriddenFeatureProviderFactory(new FeatureProviderFactory(configurationManager ?? CreateFilesystemConfigurationManager()), featureOverrides);