Rock Your Code with Code Contracts

704 views

Published on

This session will introduce developers to the new powerful new feature that is part of the .NET 4.5 framework called Code Contracts. Code Contracts brings the advantages of design-by-contract programming to .NET programming. Contracts are used to improve testing via runtime checking, enable static contract verification, and documentation generation.

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
704
On SlideShare
0
From Embeds
0
Number of Embeds
6
Actions
Shares
0
Downloads
0
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Rock Your Code with Code Contracts

  1. 1. David McCarter dotnetdave@live.com
  2. 2. Conference DVD’s • Rock Your Code DVD • Videos of sessions • Sides, sample code • More! • Rock Your Technical Interview DVD • Full length video of session • Expert Videos • Engineer Videos • Interview Questions • Slide deck • More!
  3. 3. Overview Introducing Code Contracts Pre-conditions & Post-conditions Contract Your Types With Contracts Summary
  4. 4. Overview
  5. 5.    Always check for valid parameter arguments! Perform argument validation for every public or protected method Throw meaningful exceptions to the developer for invalid parameter arguments   Use the System.ArgumentException class Or your own class derived from System.ArgumentException
  6. 6. public string FormatPhoneNumber(string str, bool bTakeOutDash) { string str1 = str.Trim(); if (bTakeOutDash) { if (11 == str.Length && -1 != str.IndexOf('-')) { str1 = ""; for (int i = 0; i < str.Length; i++) { if ("-" != str.Substring(i, 1)) { str1 = string.Concat(str1, str.Substring(i, 1)); } } } } return str1; }
  7. 7. public string FormatPhoneNumber(string str, bool bTakeOutDash) { if (string.IsNullOrWhiteSpace(str)) { throw new ArgumentNullException("str", "Phone number must be supplied."); } string str1 = str.Trim(); if (bTakeOutDash) { // Code Removed for brevity } return str1; }
  8. 8. Introducing Code Contracts Build Better Types
  9. 9.    Is an approach for designing software. It prescribes that software designers should define formal, precise and verifiable interface specifications for software components, which extend the ordinary definition of abstract data types with preconditions, post-conditions and invariants. These specifications are referred to as "contracts", in accordance with a conceptual metaphor with the conditions and obligations of business contracts.
  10. 10.  A discipline of analysis, design, implementation, management  Applications throughout the software lifecycle:  Getting the software right:        analysis, design , implementation Debugging & testing Automatic documentation Getting inheritance right Getting exception handling right! Maintenance Management
  11. 11.  Every software element is intended to satisfy a certain goal, or contract   For the benefit of other software elements (and ultimately of human users) The contract of any software element should be   Explicit Part of the software element itself
  12. 12. Precondition  What does it expect? Postcondition  What does it promise?  What does it maintain? Class invariant
  13. 13.      New API + tools from Microsoft for Designby-Contract System.Diagnostics.Contracts MSIL rewriting Inspired by Spec# Included in .NET 4.0/ 4.5  Latest version released 9/13  http://research.microsoft.com/en-us/projects/contracts/
  14. 14. Pre-conditions Post-conditions Oh My!
  15. 15.     Usually for method parameter checking Caller’s responsibility to make sure the precondition is true on entry into method Does not need to be compiled in production code Can also include throwing of Exceptions  These must be compiled into assembly
  16. 16. public static string FormatPhoneNumber(string str, bool bTakeOutDash) { Contract.Requires(string.IsNullOrWhiteSpace(str) == false); string str1 = str.Trim(); // code removed for brevity return str1; }
  17. 17. public static string FormatPhoneNumber(string str, bool bTakeOutDash) { Contract.Requires<ArgumentNullException> (string.IsNullOrWhiteSpace(str) == false); string str1 = str.Trim(); // code removed for brevity return str1; }
  18. 18.    Postconditions are contracts for the state of a method when it terminates The postcondition is checked just before exiting a method The run-time behavior of failed postconditions is determined by the runtime analyzer.
  19. 19. public static string FormatPhoneNumber(string str, bool bTakeOutDash) { Contract.Requires(string.IsNullOrWhiteSpace(str) == false); Contract.Ensures(string.IsNullOrEmpty(Contract.Result<string>()) ==false); string str1 = str.Trim(); // code removed for brevity return str1; }
  20. 20.    EnsuresOnThrow<T> OldValue ForAll   Ensures   Out parameters EndContractBlock   Collections Legacy parameter checking Abstract Methods, Overloaded Methods and more!
  21. 21. Contract Your Types With Contracts Creates MUCH Better Types!
  22. 22.  ContractInvariantMethod     Mark methods that contain object invariant specifications The methods marked with this attribute must be nullary methods with void return types and contain nothing other than calls to Contract You may not call these methods from within your code. Force coders to do proper value checking!
  23. 23. public Int32 Value { get { return _value; } private set { if (this.Value != value) { if ((value <= this.Maximum) && (value >= this.Minimum)) { this._value = value; this.OnValueChanged(); } } } }
  24. 24. public Int32 Value { get { return _value; } private set { if (this.Value != value) { Contract.Requires<ArgumentOutOfRangeException>(value >= 0); if ((value <= this.Maximum) && (value >= this.Minimum)) { this._value = value; this.OnValueChanged(); } } } }
  25. 25. private Int32 _value; [ContractInvariantMethod] private void Invariants() { Contract.Invariant(_value >= 0, "Value cannot be less than zero."); } -------------------------------------set { // Contract.Requires<ArgumentOutOfRangeException>(value >= 0); if (this.Value != value) { // Code Removed for Brevity } }
  26. 26. Summary
  27. 27.    Asserts Inheritance Attributes          ContractClass, ContractClassFor Pure RuntimeContracts ContractPublicPropertyName ContractVerification ContractRuntimeIgnored ContractOption Contracting Ordering Lots more!
  28. 28.  Pex and Moles     Isolation and White box Unit Testing for .NET Pex auto generates test suites with high code coverage Moles supports unit testing by way of detours and stubs (delegates) http://research.microsoft.com/en-us/projects/pex/
  29. 29.  Microsoft Research   http://research.microsoft.com/enus/projects/contracts/ Channel 9  http://channel9.msdn.com/Search/?Term=code %20contracts
  30. 30. Questions? All Pictures & Videos © David McCarter •Presentation Downloads •slideshare.com/dotnetdave •Please Rate My Session: •speakerrate.com/dotnetdave •David McCarter’s •.NET Coding Standards •dotnettips.com •Geek Swag •geekstuff.notlong.com @realdotnetdave davidmccarter dotnetdave@live.com

×