Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2875

Support assertions on topologyDescriptionChangedEvent in expectEvents

    • Type: Icon: Spec Change Spec Change
    • Resolution: Unresolved
    • Priority: Icon: Unknown Unknown
    • None
    • Component/s: Unified Test Runner
    • None
    • Needed
    • Hide

      Summary of necessary driver changes

      • Update Unified Test runner implementation to support assertions on the previousDescription and newDescription fields of the topologyDescriptionChangedEvent when monitoring SDAM events
      • See details of changes required here

      Commits for syncing spec/prose tests

      Context for other referenced/linked tickets

      • Required for drivers to implement tests being introduced in DRIVERS-2711
      Show
      Summary of necessary driver changes Update Unified Test runner implementation to support assertions on the previousDescription and newDescription fields of the topologyDescriptionChangedEvent when monitoring SDAM events See details of changes required here Commits for syncing spec/prose tests Pull Request: https://github.com/mongodb/specifications/pull/1556 Commit: https://github.com/mongodb/specifications/commit/688b369c7a9780c119ce58a7d890e4740a2492b8   Context for other referenced/linked tickets Required for drivers to implement tests being introduced in DRIVERS-2711
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-5516 Backlog
      CXX-2994 Backlog
      CSHARP-5016 Duplicate
      GODRIVER-3167 Backlog 2.1.0
      JAVA-5389 Backlog
      NODE-6052 Fixed 6.6.0
      MOTOR-1287 Duplicate
      PYTHON-4299 Fixed 4.7
      PHPLIB-1421 Backlog
      RUBY-3428 Backlog
      RUST-1893 Backlog
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-5516 Backlog CXX-2994 Backlog CSHARP-5016 Duplicate GODRIVER-3167 Backlog 2.1.0 JAVA-5389 Backlog NODE-6052 Fixed 6.6.0 MOTOR-1287 Duplicate PYTHON-4299 Fixed 4.7 PHPLIB-1421 Backlog RUBY-3428 Backlog RUST-1893 Backlog

      Summary

      What is the problem or use case, what are we trying to achieve?

      We want to be able to assert on the type property of the previousDescription and newDescription fields of the topologyDescriptionChanged event as described in the sdam spec. This will enable us to more easily write tests that expect topology changes without having to leverage logging. In addition, it allows for testing on the behaviour of clients that are closing as is required for DRIVERS-2711.

      Motivation

      Who is the affected end user?

      We as driver engineers are the affected users.

      How does this affect the end user?

      Makes writing tests easier.

      How likely is it that this problem or use case will occur?

      Occurs in testing

      If the problem does occur, what are the consequences and how severe are they?

      Annoyance and inconvenience of having to work against the test runner to assert certain conditions.

      Is this issue urgent?

      DRIVERS-2711 requires this ticket to be completed

      Is this ticket required by a downstream team?

      No

      Is this ticket only for tests?

      This ticket updates the unified test format spec and so will require drivers to update their unified test runner implementations.

      Acceptance Criteria

      • Add section to unified test runner specification defining the assertions that should be possible on the topologyDescriptionChangedEvent
      • Update unified test format schema
      • Add unified test format tests that ensure that the additions to the schema work as expected

            Assignee:
            warren.james@mongodb.com Warren James
            Reporter:
            warren.james@mongodb.com Warren James
            Jeremy Mikola Jeremy Mikola
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: