diff --git a/src/Microcks.Testcontainers/Connection/GenericConnection.cs b/src/Microcks.Testcontainers/Connection/GenericConnection.cs index 5655159..397006c 100644 --- a/src/Microcks.Testcontainers/Connection/GenericConnection.cs +++ b/src/Microcks.Testcontainers/Connection/GenericConnection.cs @@ -17,12 +17,32 @@ namespace Microcks.Testcontainers.Connection; +/// +/// Represents generic connection information (URL and optional credentials). +/// public class GenericConnection { + /// + /// Gets the connection URL. + /// public string Url { get; } + + /// + /// Gets the username used for authentication, if any. + /// public string Username { get; } + + /// + /// Gets the password used for authentication, if any. + /// public string Password { get; } + /// + /// Initializes a new instance of the class. + /// + /// The connection URL. + /// The username used for authentication, if any. + /// The password used for authentication, if any. public GenericConnection(string url, string username = null, string password = null) { Url = url; diff --git a/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs b/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs index 1a63238..c7e2000 100644 --- a/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs +++ b/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs @@ -28,6 +28,9 @@ namespace Microcks.Testcontainers.Helpers; /// public static class MacOSHelper { + /// + /// Gets a value indicating whether the current process is running on macOS (Darwin) on Arm64. + /// public static bool IsMacOS { get; internal set; } = RuntimeInformation.ProcessArchitecture == Architecture.Arm64 && RuntimeInformation.OSDescription.Contains("Darwin"); diff --git a/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs b/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs index 113010a..fe1422c 100644 --- a/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs +++ b/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs @@ -51,6 +51,9 @@ public class MicrocksContainerEnsemble : IAsyncDisposable, IArtifactAndSnapshotM private readonly INetwork _network; + /// + /// Gets the Docker network used by this ensemble. + /// public INetwork Network { get => this._network; } @@ -98,36 +101,66 @@ public MicrocksContainerEnsemble WithMainArtifacts(params string[] mainArtifacts return this; } + /// + /// Configures the Microcks container ensemble with the specified main remote artifacts. + /// + /// An array of remote artifact URIs/locations to be used by the Microcks container. + /// The updated instance. public MicrocksContainerEnsemble WithMainRemoteArtifacts(params string[] mainRemoteArtifacts) { this._microcksBuilder.WithMainRemoteArtifacts(mainRemoteArtifacts); return this; } + /// + /// Configures the Microcks container ensemble with the specified main remote artifacts. + /// + /// The remote artifact definitions to be used by the Microcks container. + /// The updated instance. public MicrocksContainerEnsemble WithMainRemoteArtifacts(params RemoteArtifact[] remoteArtifacts) { this._microcksBuilder.WithMainRemoteArtifacts(remoteArtifacts); return this; } + /// + /// Configures the Microcks container ensemble with the specified secondary artifacts. + /// + /// An array of secondary artifact file names to be used by the Microcks container. + /// The updated instance. public MicrocksContainerEnsemble WithSecondaryArtifacts(params string[] secondaryArtifacts) { this._microcksBuilder.WithSecondaryArtifacts(secondaryArtifacts); return this; } + /// + /// Configures the Microcks container ensemble with the specified secondary remote artifacts. + /// + /// The remote artifact definitions to be used by the Microcks container. + /// The updated instance. public MicrocksContainerEnsemble WithSecondaryRemoteArtifacts(params RemoteArtifact[] remoteArtifacts) { this._microcksBuilder.WithSecondaryRemoteArtifacts(remoteArtifacts); return this; } + /// + /// Configures the Microcks container ensemble with the specified snapshots. + /// + /// An array of snapshot file names to be loaded into the Microcks container. + /// The updated instance. public MicrocksContainerEnsemble WithSnapshots(params string[] snapshots) { this._microcksBuilder.WithSnapshots(snapshots); return this; } + /// + /// Configures the Microcks container ensemble with the specified secrets. + /// + /// The secrets to create in the Microcks container. + /// The updated instance. public MicrocksContainerEnsemble WithSecrets(params Model.Secret[] secrets) { this._microcksBuilder.WithSecrets(secrets);