[Event Hubs Client - Track Two Preview 1] Import Track One Source and Establish Test Infrastructure #6430
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pakrym
reviewed
May 29, 2019
sdk/eventhub/Azure.Messaging.EventHubs/src/Properties/AssemblyInfo.cs
Outdated
Show resolved
Hide resolved
sdk/eventhub/Azure.Messaging.EventHubs/tests/Infrastructure/Category.cs
Outdated
Show resolved
Hide resolved
6134f4a to
414ec35
Compare
Import of Track One Source
- Internal copy of the track one source was made for intended use as implementation basis
for the preview API surface.
- Changed the namespace used within the Track One source to avoid any ambiguity what the official
API surface was.
- Rescoped visibility for all Track One source classes, limiting them to `internal` so that consumers of
the preview are not exposed to them.
- Marked internals as visible to the client library, so that the internal types from Track One can be used
as part of the compatibility layer.
General
- Making internals visible to the test library so that non-API types can
be unit tested.
- Removed `PartitionCount` from the `EventHubProperties` metadata, at the request of the architecture board
as part of the Python client review.
- Performed some minor cleanup and renaming of members to better align cross-language.
General
- Removed code signing compiler constant, assuming that projects will
be signed, now that keys are owned by the repository.
Tests and Test Infrastructure
- Converted prototype skeleton test framework from xUnit to NUnit, to
conform to the adopted standard for track two client libraries.
- Initial set of test infrastructure for categorizing tests and accessing
environment variables.
- Tests for the `Guard` class, the first non-prototype implementation for the
track two preview code.
414ec35 to
b9c6dbd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The goal of these changes to begin laying the groundwork for implementation of the first preview for the track two API. The API surface for the initial preview will base it's implementation on the track one source using a compatibility layer in order to speed delivery.
Goals
Expose the track two API surface for consumers of the client library, while delegating implementation to the track one source.
Ensure that the track one API is not exposed to consumers, allowing them to experience the track two API design.
Isolate the track one source such that it will be easily identified when efforts to create the full track two implementation are begun; this should focus both on the track one implementation as well as the areas that it is consumed within the track two preview implementation.
Non-Goals
Providing the implementation for track two; the first preview will focus on design and implementation of the API surface, while delegating functionality.
Refactoring or enhancing the track one source beyond minimally-scoped areas, needed specifically for compatibility.
Import of the full test suite for the track one implementation; tests will focus on the core scenarios identified for the track two preview.
Inclusion of the full set of supporting assets, such as README, samples, and ARM templates; these will happen as part of future efforts.
Enabling test parallelism; this will be a stretch goal, but unlikely to occur in the time frame for the first track two preview.
Details
Import of Track One Source
Internal copy of the track one source was made for intended use as the basis of implementation for the track two preview.
Changed the namespace used within the track one source to avoid any ambiguity what the official API surface was.
Rescoped visibility for all track one source classes, limiting them to
internalso that consumers of the preview are not exposed to them.Marked internals as visible to the client library, so that the internal types from Track One can be used as part of the compatibility layer.
General
Making internals visible to the test library so that non-API types can be unit tested.
Removed
PartitionCountfrom theEventHubPropertiesmetadata, at the request of the architecture board as part of the Python client review.Performed some minor cleanup and renaming of members to better align cross-language.
Tests and Test Infrastructure
Converted prototype skeleton test framework from xUnit to NUnit, to conform to the adopted standard for track two client libraries.
Initial set of test infrastructure for categorizing tests and accessing environment variables.
Tests for the
Guardclass, the first non-prototype implementation for the track two preview code.Last Upstream Rebase
Wednesday, May 29, 2019 4:17pm (EDT)
Resources
Related and Follow-Up Issues