DotNetDocsTestBase Class

Namespace: CloudNimble.DotNetDocs.Tests.Shared
Assembly: CloudNimble.DotNetDocs.Tests.Shared.dll

📋 Definition

public class DotNetDocsTestBase : CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase

Inheritance Hierarchy

📝 Summary

Base class providing core infrastructure for documentation generation tests. This class extends BreakdanceMSTestBase and provides utilities for working with assembly documentation.

🎯 Members

Fields
Constructors
Methods

projectPath

const string

required

Constant defining the project path for test resources

public const string projectPath

Access Modifier: public
Modifiers: const
Type: string

DotNetDocsTestBase()

Default constructor that initializes the base class

public DotNetDocsTestBase()

Access Modifier: public
Parameters: None
Returns: New instance of DotNetDocsTestBase

Usage Example

// Create a new test base instance
var testBase = new DotNetDocsTestBase();

// Use in a derived test class
public class MyDocTest : DotNetDocsTestBase
{
    public MyDocTest() : base()
    {
        // Custom initialization
    }
}

GetTestsDotSharedAssembly

method

Retrieves the documentation assembly for the Tests.Shared project

public CloudNimble.DotNetDocs.Core.DocAssembly GetTestsDotSharedAssembly()

Access Modifier: public
Returns: CloudNimble.DotNetDocs.Core.DocAssembly

Return Value

Returns a DocAssembly object containing:

Assembly metadata
Namespace documentation
Type information
Member details

Usage Example

var testBase = new DotNetDocsTestBase();
var assembly = testBase.GetTestsDotSharedAssembly();

// Access assembly information
Console.WriteLine($"Assembly: {assembly.AssemblyName}");
Console.WriteLine($"Namespaces: {assembly.Namespaces.Count}");

// Iterate through namespaces
foreach (var ns in assembly.Namespaces)
{
    Console.WriteLine($"  - {ns.Name}");
}

💡 Usage Examples

using CloudNimble.DotNetDocs.Tests.Shared;

// Create test base instance
var testBase = new DotNetDocsTestBase();

// Get assembly documentation
var assembly = testBase.GetTestsDotSharedAssembly();

// Use the project path constant
var projectPath = DotNetDocsTestBase.projectPath;
Console.WriteLine($"Project path: {projectPath}");

🔧 Implementation Details

Thread Safety

This class is not thread-safe for instance members. Static members (like projectPath) are thread-safe.

Inheritance Notes

Inherits from BreakdanceMSTestBase
Can be further extended for specialized test scenarios
Virtual members can be overridden in derived classes

Performance Considerations

GetTestsDotSharedAssembly() may perform file I/O operations
Consider caching the result if called multiple times
The projectPath constant has no runtime overhead

DocAssembly

Return type of GetTestsDotSharedAssembly

BreakdanceMSTestBase

Base class providing MSTest functionality

SampleClass

Related class in same namespace

⚠️ Important Notes

The projectPath field is a compile-time constant. Changing it requires recompilation of all dependent assemblies.

This class is designed for use in test scenarios. It may not be suitable for production use without modification.

For best results, inherit from this class when creating documentation-related tests to leverage the built-in infrastructure.

📚 See Also

Need help? Check out the quickstart guide or explore usage examples.

Getting Started

Guides

Component Showcase

API Reference

DotNetDocsTestBase

DotNetDocsTestBase Class

📋 Definition

📝 Summary

🎯 Members

projectPath

DotNetDocsTestBase()

GetTestsDotSharedAssembly

💡 Usage Examples

🔧 Implementation Details

DocAssembly

BreakdanceMSTestBase

SampleClass

⚠️ Important Notes

📚 See Also

Getting Started

Guides

Component Showcase

API Reference

​DotNetDocsTestBase Class

​📋 Definition

​📝 Summary

​🎯 Members

​projectPath

​DotNetDocsTestBase()

​GetTestsDotSharedAssembly

​💡 Usage Examples

​🔧 Implementation Details

​🔗 Related Types

DocAssembly

BreakdanceMSTestBase

SampleClass

​⚠️ Important Notes

​📚 See Also

DotNetDocsTestBase Class

📋 Definition

📝 Summary

🎯 Members

projectPath

DotNetDocsTestBase()

GetTestsDotSharedAssembly

💡 Usage Examples

🔧 Implementation Details

🔗 Related Types

⚠️ Important Notes

📚 See Also