Samples for Mocking Client Types

Summary

The Event Hubs client library aims to be mockable and fully support testability. To help illustrate usage of the new API for the testing scenarios, a set of samples mocking the various Event Hubs client types and illustrating use of the model factory is needed.

Scope of Work

• Implement a sample or set of samples demonstrating a basic approach for mocking the high level client types for their core scenarios. Included should be:
  

  • EventHubProducerClient
  • EventHubConsumerClient
  • EventProcessorClient
  • PartitionReceiver
  • EventProcessor<TPartition>
    
    

• Ensure that the use of the model factory is demonstrated for key types, including:
  

  • EventData
  • EventDataBatch
  • EventHubProperties
  • PartitionProperties
  • PartitionPublishingProperties
  • LastEnqueuedEventProperties
  • PartitionContext

Success Criteria

• The sample(s) have been created, with a clear and simple approach and detailed discussion to support the goal of helping those unfamiliar with Event Hubs to get started testing its types.

• The sample(s) adhere to the coding conventions and standards defined for track two libraries.

• All projects in the solution compile; any warnings that exist have either been fixed or additional work items filed to address them if they were deemed non-critical.

• The sample(s) follow the pattern within the Event Hubs library, are compiled and executed as part of the Live test suite.

Related

The following are promising pull requests begun by a community member before they were unable to complete due to time constraints. These would serve as a great starting point.

• Samples for Mocking Client Types (EventProcessor)
• Samples for Mocking Client Types (EventHubProducerClient)

References

• .NET Guidelines (Mocking)
• Updating Sample Snippets (Contributing Guide)
• Event Hubs Hello World Sample
• Hello World Snippets (1/2)
• Hello World Snippets (2/2)

[jsquire]

Yes, this work has not been completed. There have been some contributions that formed a good foundation for the samples, but there is still some work needed to complete the sample.

[samjones00]

Should this issue still have the status of Open?