Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements of Allure.Net.Commons #459

Merged
merged 9 commits into from
Mar 28, 2024
Merged

Improvements of Allure.Net.Commons #459

merged 9 commits into from
Mar 28, 2024

Conversation

delatrie
Copy link
Contributor

@delatrie delatrie commented Mar 25, 2024

Context

This PR contains some preliminary changes to Allure.Net.Commons in order to enhance other adapters later (including a new one for Reqnroll):

  1. Put all packages in line in terms of distinguishing between broken and failed tests, steps, and fixtures.
  2. Factor out testCaseId computation.
  3. Add AllureTestPlan.SkipReason to align test plan skip messages across adapters.
  4. Add AllureLifecycle.ScheduleTestCase to prepare (but not start yet) a test case.
  5. A new implementation for AllureApi.AddScreenDiff (closes Reimplement AllureApi.AddScreenDiff using the new screen-diff-plugin's attachment viewer #435).

It also removes the following deprecated parts of the API:

  • AllureLifecycle:
    • CurrentTestIdGetter (not used for anything)
    • UUID-based lifecycle management methods:
      • StartTestContainer
      • UpdateTestContainer
      • StopTestContainer
      • WriteTestContainer
      • StartBeforeFixture
      • StartAfterFixture
      • UpdateFixture
      • StopFixture
      • StartTestCase
      • UpdateTestCase
      • StopTestCase
      • WriteTestCase
      • StartStep
      • UpdateStep
      • StopStep
        As no UUID-specific methods are currently in place, the entirety of AllureStorage was removed, leaving AllureContext as the only state container in Allure.Net.Commons.
    • User API methods that have been moved to AllureApi/ExtendedApi:
      • AddAttachment
      • AddScreenDiff
    • Some old private methods not currently in use
  • Step-related classes not currently in use:
    • StepFailedException
    • IStepLogger
    • IStepActionLogger
  • CoreStepsHelper (functionality has been moved to AllureApi/ExtendedApi)

@delatrie delatrie force-pushed the commons-fixes-2403 branch from b39af2c to 4b5a1e1 Compare March 26, 2024 19:45
@delatrie delatrie force-pushed the repo-maintenance-2403 branch from 76b0ca8 to 5f664a2 Compare March 26, 2024 21:38
@delatrie delatrie force-pushed the commons-fixes-2403 branch from 4b5a1e1 to 0ea51e9 Compare March 26, 2024 21:43
@delatrie delatrie force-pushed the repo-maintenance-2403 branch from 5f664a2 to f92c366 Compare March 27, 2024 09:45
@delatrie delatrie force-pushed the commons-fixes-2403 branch from 0ea51e9 to 35aeded Compare March 27, 2024 09:48
@delatrie delatrie force-pushed the repo-maintenance-2403 branch from f92c366 to f92459c Compare March 28, 2024 10:49
@delatrie delatrie force-pushed the commons-fixes-2403 branch from efc568a to 61705d9 Compare March 28, 2024 10:50
  - ScheduleTestCase(TestResult) - adds a test, activates the context
  - StartTestCase() - set the test's stage and start time
  - AllureLifecycle:
      - CurrentTestIdGetter
    UUID-based lifecycle management methods:
      - StartTestContainer
      - UpdateTestContainer
      - StopTestContainer
      - WriteTestContainer
      - StartBeforeFixture
      - StartAfterFixture
      - UpdateFixture
      - StopFixture
      - StartTestCase
      - UpdateTestCase
      - StopTestCase
      - WriteTestCase
      - StartStep
      - UpdateStep
      - StopStep
    Use API methods:
      - AddAttachment
      - AddScreenDiff
    Some old private methods not currently in use
  - StepFailedException
  - IStepLogger
  - IStepActionLogger
  - CoreStepsHelper
@delatrie delatrie changed the base branch from repo-maintenance-2403 to main March 28, 2024 13:21
@delatrie delatrie marked this pull request as ready for review March 28, 2024 13:23
@delatrie delatrie merged commit 0ae2604 into main Mar 28, 2024
3 checks passed
@delatrie delatrie deleted the commons-fixes-2403 branch March 28, 2024 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reimplement AllureApi.AddScreenDiff using the new screen-diff-plugin's attachment viewer
3 participants