Remove Jenkinsfile and add unit tests for various models including Address, Domain, Nameserver, Section, Session, Subnetwork, Tag, Vlan, and Vrf. Introduce mock classes for HTTP requests and cmdlet testing.
This commit is contained in:
139
classlib.tests/Mocks/CmdletTestHelper.cs
Normal file
139
classlib.tests/Mocks/CmdletTestHelper.cs
Normal file
@@ -0,0 +1,139 @@
|
||||
namespace PS.IPAM.Tests.Mocks;
|
||||
|
||||
using System.Management.Automation;
|
||||
using System.Management.Automation.Host;
|
||||
using System.Reflection;
|
||||
|
||||
/// <summary>
|
||||
/// Helper class for testing PowerShell cmdlets.
|
||||
/// </summary>
|
||||
public class CmdletTestHelper<T> : IDisposable where T : PSCmdlet, new()
|
||||
{
|
||||
private readonly T _cmdlet;
|
||||
private readonly List<object> _output = new();
|
||||
private readonly List<ErrorRecord> _errors = new();
|
||||
private bool _disposed;
|
||||
|
||||
public CmdletTestHelper()
|
||||
{
|
||||
_cmdlet = new T();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the cmdlet instance for setting parameters.
|
||||
/// </summary>
|
||||
public T Cmdlet => _cmdlet;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the output objects written by the cmdlet.
|
||||
/// </summary>
|
||||
public IReadOnlyList<object> Output => _output.AsReadOnly();
|
||||
|
||||
/// <summary>
|
||||
/// Gets the errors written by the cmdlet.
|
||||
/// </summary>
|
||||
public IReadOnlyList<ErrorRecord> Errors => _errors.AsReadOnly();
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether any errors were written.
|
||||
/// </summary>
|
||||
public bool HasErrors => _errors.Count > 0;
|
||||
|
||||
/// <summary>
|
||||
/// Invokes the cmdlet and captures output.
|
||||
/// </summary>
|
||||
public void Invoke()
|
||||
{
|
||||
// Use reflection to call the protected ProcessRecord method
|
||||
var processMethod = typeof(T).GetMethod("ProcessRecord",
|
||||
BindingFlags.NonPublic | BindingFlags.Instance);
|
||||
|
||||
if (processMethod == null)
|
||||
{
|
||||
throw new InvalidOperationException("ProcessRecord method not found on cmdlet.");
|
||||
}
|
||||
|
||||
// Set up a mock command runtime to capture output
|
||||
var runtime = new MockCommandRuntime(_output, _errors);
|
||||
var runtimeProperty = typeof(Cmdlet).GetProperty("CommandRuntime",
|
||||
BindingFlags.Public | BindingFlags.Instance);
|
||||
|
||||
runtimeProperty?.SetValue(_cmdlet, runtime);
|
||||
|
||||
// Invoke the method
|
||||
try
|
||||
{
|
||||
processMethod.Invoke(_cmdlet, null);
|
||||
}
|
||||
catch (TargetInvocationException ex) when (ex.InnerException != null)
|
||||
{
|
||||
// Unwrap the exception
|
||||
throw ex.InnerException;
|
||||
}
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
if (!_disposed)
|
||||
{
|
||||
_disposed = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Mock implementation of ICommandRuntime for capturing cmdlet output.
|
||||
/// This is a minimal implementation that only handles the methods we need for testing.
|
||||
/// </summary>
|
||||
internal class MockCommandRuntime : ICommandRuntime
|
||||
{
|
||||
private readonly List<object> _output;
|
||||
private readonly List<ErrorRecord> _errors;
|
||||
|
||||
public MockCommandRuntime(List<object> output, List<ErrorRecord> errors)
|
||||
{
|
||||
_output = output;
|
||||
_errors = errors;
|
||||
}
|
||||
|
||||
public PSHost Host => null!;
|
||||
public PSTransactionContext CurrentPSTransaction => null!;
|
||||
|
||||
public bool ShouldContinue(string query, string caption) => true;
|
||||
public bool ShouldContinue(string query, string caption, ref bool yesToAll, ref bool noToAll) => true;
|
||||
public bool ShouldProcess(string target) => true;
|
||||
public bool ShouldProcess(string target, string action) => true;
|
||||
public bool ShouldProcess(string verboseDescription, string verboseWarning, string caption) => true;
|
||||
public bool ShouldProcess(string verboseDescription, string verboseWarning, string caption, out ShouldProcessReason shouldProcessReason)
|
||||
{
|
||||
shouldProcessReason = ShouldProcessReason.None;
|
||||
return true;
|
||||
}
|
||||
|
||||
public bool TransactionAvailable() => false;
|
||||
|
||||
public void ThrowTerminatingError(ErrorRecord errorRecord) => throw errorRecord.Exception;
|
||||
|
||||
public void WriteCommandDetail(string text) { }
|
||||
public void WriteDebug(string text) { }
|
||||
public void WriteError(ErrorRecord errorRecord) => _errors.Add(errorRecord);
|
||||
public void WriteObject(object sendToPipeline) => _output.Add(sendToPipeline);
|
||||
public void WriteObject(object sendToPipeline, bool enumerateCollection)
|
||||
{
|
||||
if (enumerateCollection && sendToPipeline is System.Collections.IEnumerable enumerable)
|
||||
{
|
||||
foreach (var item in enumerable)
|
||||
{
|
||||
_output.Add(item);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
_output.Add(sendToPipeline);
|
||||
}
|
||||
}
|
||||
public void WriteProgress(ProgressRecord progressRecord) { }
|
||||
public void WriteProgress(long sourceId, ProgressRecord progressRecord) { }
|
||||
public void WriteVerbose(string text) { }
|
||||
public void WriteWarning(string text) { }
|
||||
}
|
||||
172
classlib.tests/Mocks/MockHttpMessageHandler.cs
Normal file
172
classlib.tests/Mocks/MockHttpMessageHandler.cs
Normal file
@@ -0,0 +1,172 @@
|
||||
namespace PS.IPAM.Tests.Mocks;
|
||||
|
||||
using System.Net;
|
||||
|
||||
/// <summary>
|
||||
/// A mock HTTP message handler for testing HTTP requests without making actual network calls.
|
||||
/// This handler does not dispose itself when the HttpClient is disposed, allowing reuse in tests.
|
||||
/// </summary>
|
||||
public class MockHttpMessageHandler : HttpMessageHandler
|
||||
{
|
||||
private readonly Queue<MockResponse> _responses = new();
|
||||
private readonly List<HttpRequestMessage> _requests = new();
|
||||
private bool _disposed = false;
|
||||
|
||||
/// <summary>
|
||||
/// Gets all requests that were sent through this handler.
|
||||
/// </summary>
|
||||
public IReadOnlyList<HttpRequestMessage> Requests => _requests.AsReadOnly();
|
||||
|
||||
/// <summary>
|
||||
/// Gets the last request that was sent through this handler.
|
||||
/// </summary>
|
||||
public HttpRequestMessage? LastRequest => _requests.LastOrDefault();
|
||||
|
||||
/// <summary>
|
||||
/// Queues a response to be returned for the next request.
|
||||
/// </summary>
|
||||
public MockHttpMessageHandler WithResponse(HttpStatusCode statusCode, string content, string contentType = "application/json")
|
||||
{
|
||||
_responses.Enqueue(new MockResponse(statusCode, content, contentType));
|
||||
return this;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Queues a successful JSON response.
|
||||
/// </summary>
|
||||
public MockHttpMessageHandler WithJsonResponse(string jsonContent)
|
||||
{
|
||||
return WithResponse(HttpStatusCode.OK, jsonContent, "application/json");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Queues a successful response with phpIPAM-style wrapper.
|
||||
/// </summary>
|
||||
public MockHttpMessageHandler WithSuccessResponse(string dataJson)
|
||||
{
|
||||
var response = $"{{\"code\":200,\"success\":true,\"data\":{dataJson}}}";
|
||||
return WithJsonResponse(response);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Queues a 404 Not Found response.
|
||||
/// </summary>
|
||||
public MockHttpMessageHandler WithNotFoundResponse()
|
||||
{
|
||||
return WithResponse(HttpStatusCode.NotFound, "{\"code\":404,\"success\":false,\"message\":\"Not found\"}", "application/json");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Queues an error response.
|
||||
/// </summary>
|
||||
public MockHttpMessageHandler WithErrorResponse(HttpStatusCode statusCode, string message)
|
||||
{
|
||||
var response = $"{{\"code\":{(int)statusCode},\"success\":false,\"message\":\"{message}\"}}";
|
||||
return WithResponse(statusCode, response, "application/json");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Queues an exception to be thrown on the next request.
|
||||
/// </summary>
|
||||
public MockHttpMessageHandler WithException(Exception exception)
|
||||
{
|
||||
_responses.Enqueue(new MockResponse(exception));
|
||||
return this;
|
||||
}
|
||||
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
if (_disposed)
|
||||
{
|
||||
throw new ObjectDisposedException(nameof(MockHttpMessageHandler));
|
||||
}
|
||||
|
||||
_requests.Add(request);
|
||||
|
||||
if (_responses.Count == 0)
|
||||
{
|
||||
throw new InvalidOperationException("No mock response configured. Call WithResponse() before making requests.");
|
||||
}
|
||||
|
||||
var mockResponse = _responses.Dequeue();
|
||||
|
||||
if (mockResponse.Exception != null)
|
||||
{
|
||||
throw mockResponse.Exception;
|
||||
}
|
||||
|
||||
var response = new HttpResponseMessage(mockResponse.StatusCode)
|
||||
{
|
||||
Content = new StringContent(mockResponse.Content, System.Text.Encoding.UTF8, mockResponse.ContentType),
|
||||
RequestMessage = request
|
||||
};
|
||||
|
||||
return Task.FromResult(response);
|
||||
}
|
||||
|
||||
protected override void Dispose(bool disposing)
|
||||
{
|
||||
// Don't actually dispose - allow reuse in tests
|
||||
// The test itself is responsible for cleanup
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Actually disposes the handler. Call this in test cleanup.
|
||||
/// </summary>
|
||||
public void ForceDispose()
|
||||
{
|
||||
_disposed = true;
|
||||
base.Dispose(true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verifies that a request was made to the expected URL.
|
||||
/// </summary>
|
||||
public bool WasRequestMadeTo(string urlContains)
|
||||
{
|
||||
return _requests.Any(r => r.RequestUri?.ToString().Contains(urlContains) == true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verifies that a request with the expected method was made.
|
||||
/// </summary>
|
||||
public bool WasRequestMadeWithMethod(HttpMethod method)
|
||||
{
|
||||
return _requests.Any(r => r.Method == method);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value of a header from the last request.
|
||||
/// </summary>
|
||||
public string? GetLastRequestHeader(string headerName)
|
||||
{
|
||||
if (LastRequest?.Headers.TryGetValues(headerName, out var values) == true)
|
||||
{
|
||||
return values.FirstOrDefault();
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private class MockResponse
|
||||
{
|
||||
public HttpStatusCode StatusCode { get; }
|
||||
public string Content { get; }
|
||||
public string ContentType { get; }
|
||||
public Exception? Exception { get; }
|
||||
|
||||
public MockResponse(HttpStatusCode statusCode, string content, string contentType)
|
||||
{
|
||||
StatusCode = statusCode;
|
||||
Content = content;
|
||||
ContentType = contentType;
|
||||
}
|
||||
|
||||
public MockResponse(Exception exception)
|
||||
{
|
||||
Exception = exception;
|
||||
StatusCode = HttpStatusCode.InternalServerError;
|
||||
Content = string.Empty;
|
||||
ContentType = string.Empty;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user