Migrating to SimplyVBUnit: Converting Legacy Tests from Other Frameworks

Migrating to SimplyVBUnit: Converting Legacy Tests from Other Frameworks

Overview

Migrating legacy tests to SimplyVBUnit involves assessing existing tests, mapping test patterns to SimplyVBUnit features, converting test code, and updating build/CI integration. Goal: preserve coverage and test intent while improving maintainability.

Pre-migration checklist

• Inventory: list test projects, frameworks (e.g., NUnit, MSTest, xUnit), and total number of tests.
• Dependencies: note mocking libraries, assertion helpers, test data files, and custom runners.
• CI: identify current build/CI pipelines and test runners.
• Coverage goals: decide whether to keep, expand, or reduce current coverage.

Mapping common concepts

• Test fixtures / classes: map framework-specific attributes to SimplyVBUnit equivalents (test class and test method declarations).
• Setup/Teardown: convert [SetUp]/[TearDown] or [TestInitialize]/[TestCleanup] to SimplyVBUnit’s setup/teardown constructs.
• Assertions: replace framework-specific asserts with SimplyVBUnit assertion API (equalities, null checks, exception expectations).
• Parametrized / data-driven tests: translate data-driven constructs (TestCase, DataRow) into SimplyVBUnit’s data-driven features.
• Mocking: ensure existing mocks (Moq, NSubstitute) remain compatible; if not, refactor to supported mocking approach or wrap in adapters.
• Ignored/Skipped tests: carry over skip/ignore metadata and reasons.

Step-by-step migration process

1. Pick a pilot project: choose a small, representative test project with varied test types.
2. Set up SimplyVBUnit: add the SimplyVBUnit NuGet package and any required adapters to the pilot project.
3. Convert test class-by-class: for each test class:
   • Replace framework attributes with SimplyVBUnit equivalents.
   • Update using/imports to reference SimplyVBUnit namespaces.
   • Replace assertion calls and exception assertions.
   • Adjust setup/teardown code.
4. Update test data and mocks: migrate or adapt mocking usage; ensure test data files are located and loaded correctly.
5. Run and fix failures: execute the test suite, fix API differences, and confirm behavior parity.
6. Integrate with CI: update test runner commands in CI scripts to use SimplyVBUnit’s test runner.
7. Iterate and expand: apply changes to remaining projects; monitor test coverage and flaky tests.
8. Retire old framework packages: once all tests pass, remove legacy test framework dependencies.

Practical tips

• Automate mechanical changes: use search-and-replace, Roslyn analyzers, or codemods for attribute and assert replacements.
• Keep both frameworks during transition: allow incremental migration by keeping both test runners until all tests convert.
• Preserve test semantics: focus on preserving intent—refactor only when necessary for compatibility.
• Measure coverage: run coverage tools after migration to ensure parity.
• Document differences: keep a migration guide for your team listing common mappings and gotchas.

Common pitfalls

• Missing equivalents for certain assertion helpers — create small adapter helpers to emulate behavior.
• Incompatible mocking setups — test against real implementations or wrap mocking calls.
• CI test discovery changes — ensure test runner arguments and test discovery patterns are updated.
• Flaky tests exposed by different execution order — stabilize by removing inter-test dependencies.

Example conversion (conceptual)

• MSTest:
  • [TestClass] -> SimplyVBUnit test class attribute
  • [TestMethod] -> SimplyVBUnit test method attribute
  • Assert.AreEqual(expected, actual) -> SimplyVBUnit.Assert.Equal(expected, actual)
  • [DataRow(…)] -> SimplyVBUnit data-driven attribute

Rollout checklist

• Pilot migrated and validated
• CI updated and green
• Coverage verified
• Training/README for team
• Legacy framework packages removed