Welcome!

Microsoft Cloud Authors: Janakiram MSV, Yeshim Deniz, David H Deans, Andreas Grabner, Stackify Blog

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

Including Assertions in .NET Assemblies

Including Assertions in .NET Assemblies

.NET assemblies are superior to previous component technologies because they seamlessly provide multilingual support; introduce an excellent synergy between code and metadata; and inspire confidence through a strong type system and the .NET security policy. Nevertheless, .NET lacks a formal mechanism for specifying the semantics of the types offered by an assembly.

This article shows how, using .NET attributes, it is feasible to introduce Boolean assertion clauses in .NET assemblies. Using reflection, these assertion attributes can be extracted, checked, and monitored at runtime. We offer an assertion browser tool that extracts the assertion attributes from the assemblies for documentation purposes and generates a "trusted" proxy assembly to monitor these assertions at runtime.

Introduction
Bertrand Meyer included the assertion formalism in Eiffel under his Design by Contract metaphor. Works for other languages such as Java and C++ recognize the significance of assertions. This article introduces assertions in .NET code through attributes. This approach changes neither .NET languages nor .NET compilers.

The resulting asserted assembly will have two advantages:
1. To serve as a documentation vehicle: Because assertions are inserted as attributes, they are formal metadata integrated into the assembly.
2. To increase the developer's trust in the assembly: Because assertions can be checked and monitored at runtime by means of reflection, the developer can verify that the assembly really does what the assertions say it does.

Components in Previous Technologies
Technologies like CORBA and COM use IDLs (Interface Definition Languages), but these IDLs do not include more semantic information than that which can be deduced from types, methods, and parameter names.

Java technology alleviates this drawback, but has the following weaknesses:

  • The monolinguistic approach. A Java component can be used only by another Java component. There is no seamless and comfortable way to connect an EJB component to a component developed in another language and vice versa.
  • The documentation extracted from a component consists only of type signatures and comments.
  • The Java reflection mechanism is unable to recover the "information" embedded as comments. Developers must work directly with the internals of the Java bytecode files.

    Strengths of .NET Assemblies
    .NET components are supported by assemblies.

  • A .NET assembly is language neutral. It can be used transparently from any other .NET assembly, independently of the source languages that produced each.
  • A .NET assembly contains code, data, and metadata. Metadata can be fully extracted using .NET reflection capabilities.
  • .NET introduces a new metadata feature: attributes. Through attributes we can include our own custom metadata in assemblies.

    The Convenience of More Trusted .NET Assemblies
    The .NET signing policy is based on confidence in the human (enterprise) author of the assembly, but this is not enough for reliability. Applications are not forced to use the types of an assembly under the "contract" that these types request (in the BCL these "contracts" appear in a verbose fashion). We need a more organized documentation to verify that an assembly does what it says it does.

    How can an assembly exporting a type Stack, with a Push method and a property Top, prohibit its client assemblies from applying Top to a stack s if s is empty? How can the same assembly guarantee that after pushing an object x in s, the property Top will return x?

    Including Assertions by Means of .NET Attributes
    The proposed assertions are represented by the interface:

    interface IAssertion{
    string BoolExpression {get;}
    string Label {get; set;}
    bool Inherited {get;}
    }

    The class AssertionAttribute implements IAssertion and extends the .NET SystemAttribute. This class allows the inclusion of the assertion attributes in the source code during compilation.

    The target of an assertion attribute will be a type or a method (including properties and constructors). The assembly resulting from the compilation of a project with those assertion attributes will be called the asserted assembly.

    The assertions are really the raw string parameters of these attri- butes, which are returned by the property BoolExpression. They must denote logical expressions under a notation named C#AL (C#-like Assertion Language).

    For example, the string "!Empty" used in the assertion attribute of the method Pop (see Listing 1) helps to specify that a stack cannot be popped if it is empty.

    The property Label = "To pop an element the stack cannot be empty" defines a textual message about the assertion's semantics.

    The Inherited property states whether the assertion will also apply to a derived type or method.

    The AssertionAttribute class has three derived types. The Invariant- Attribute derives from Assertion-Attribute. The AttributeUsage attribute is used to define the possible targets of this InvariantAttribute, which in this case are classes, interfaces, or structs (see Listing 2).

    For an InvariantAttribute the BoolExpression should be true before and after applying any public method of the type attached to the attribute.

    Because the property Allow-Multiple is set to true, several invariant attributes can be targeted to a single type. A logical conjunction (&&) will be applied to all Boolean expressions.

    When assertions are monitored during runtime and && evaluates to false, then an InvariantException will be thrown. The Label property will be part of the exception message.

    The following excerpt shows an invariant attribute attached to a Rational type:

    [Invariant("Denominator != 0", Label="Denominator cannot be zero")]
    struct Rational{
    ...
    public int Numerator{
    ...
    }
    public int Denominator{
    ...
    }
    }

    PreconditionAttribute and PostconditionAttribute also derive from AssertionAttribute. Under the Design by Contract guidelines, a PreconditionAttribute denotes a condition required by the assembly before applying the public method targeted by the attribute, and a PostconditionAttribute denotes a condition that will be ensured by the assembly after applying the method targeted by the attribute.

    Note: The Push method of the Stack type (see Listing 1) has three postconditions (the property AllowMultiple of the Post- conditionAttribute is true).

    interface Stack {
    ...
    [Precondition("!Full",
    Label="Stack Overflow")]
    [Postcondition("!Empty")]
    [Postcondition("Total == Total.Old + 1")]
    [Postcondition("Top == x", Label="The Stack applies a
    LIFO policy")]
    public void Push(object x);
    ...
    }

    The attribute [Precondition ("!Full", Label="Stack Overflow")] states that to push the stack, it cannot be full; the attribute [Postcondition("!Empty")] states that after pushing, the stack will not be empty; and the [Postcondition ("Total == Total.Old + 1")] states that the total of elements in the stack will be one plus the old value of Total before executing the push. The attribute [Postcondition("Top == x", Label="The Stack applies a LIFO policy")] means that the pushed element will be at the top of the stack.

    The InvariantException, PreconditionException, and PostconditionException types, derived from the base class AssertionException, represent the exceptions to be thrown when the corresponding assertion is not fulfilled at runtime.

    Assertion Attributes and Inheritance
    An invariant defined in a base type must be fulfilled by the instances of each derived type. Preconditions and postconditions targeting a virtual base method must be fulfilled by the corresponding overriding method.

    The above approach fits well with classes implementing an interface base type, but it should not necessarily be applied when a class extends another base class. If the Inheritable property is set to false, a developer of a derived method is not forced to guarantee the assertions of the corresponding base method. For example, the following class Account does not require a derived class CreditAccount to conform to the precondition "Balance > amount" when overriding the method Withdraw, because a CreditAccount allows a negative Balance.

    class Account{
    ..
    [Precondition("Balance >
    amount")]
    [Postcondition("Balance ==
    Balance.Old - amount")]
    public virtual void Withdraw(intamount){
    ...
    }
    }

    The C# Assertion Language (C#AL)
    Each BoolExpression parameter in the assertion attributes must describe a C#-like Boolean expression (an analogous approach could be applied to other .NET languages). An entity appearing in the expression must observe the following rules:
    1. It must be public in order to be used and tested by client code in other assemblies. If the Full property of the Stack type (see Listing 1) were not public, then it would make no sense for the method Push to have the precondition "!Full".
    2. Pre- and postconditions of an instance method can use both instance and static features of the type defining the method.
    3. Pre- and postconditions of a static method can use only the type's static features.

    C#AL includes a special property, Old, which can be applied to any term used in a method's postcondition. This property returns the corresponding value of the term before the method's execution. The attribute

    [Postcondition("Total == Total.Old + 1",Label="The stack must
    increase by one element"]

    attached to the Push method, expresses that after pushing an element, the Total property must return a value equal to the value of Total before the execution of Push (denoted by Total.Old) increased by 1.

    When x is of reference type x.Old returns a copy of the reference. But if the dynamic type of the object attached to x implements the interface ICloneable, the returned value is a clone of x. So by implementing the method Clone and overriding the method Equals, developers can decide how deeply to apply the Old policy.

    A special variable, "result," can be used in the postcondition of a nonvoid method; it will refer to the returning value of the method. For example, the property Tomorrow (see Listing 3) has the postcondition:

    [Postcondition("result-this == 1",
    Label = "Tomorrow is the day after today")]

    Others operators are => (implies) and <=> (if only if). These operators facilitate design and improve readability, as shown in the invariant assertion attribute of the Date type (see Listing 3).

    Quantifiers in C#AL
    Several previous papers have recognized the relevance of quantifiers in assertions. Fortunately .NET standardizes the notion of collection based on the IEnumerable interface. Furthermore, C# includes the foreach operator. So, based on these features, C#AL includes the universal quantifier "forall" and the existential quantifier "exists":

    forall (T x in C : E)

    and

    exists (T x in C : E)

    where T is a type, x is a variable, C is an expression denoting a collection of returning objects of some type that can be cast to T, and E is a Boolean expression in which the variable x should appear. The forall operator evaluates true if for all x in C the expression E evaluates to true; otherwise it evaluates to false. The operator exists evaluates to true if at least one x in C exists such that the expression E evaluates to true; otherwise it evaluates to false.

    Both operators will throw an InvalidCast exception if the object returned by the iteration cannot be cast to T. If you want to apply an assertion to only a subset of C, you can use the following pattern:

    forall (object x in C : (x is T) => E')

    where E' is the expression resulting from changing all occurrences of x in E by the cast (T)x.

    An Employee type having a property MyDepartment and a Department type having an Employees property could have the following invariants:

    [Invariant("forall (Employee e in Employees : e.MyDepartment ==
    this)",Label = "Legal Department")]
    class Department {
    ...
    }
    [Invariant("exists (Employee e in MyDepartment.Employees : e ==
    this)",Label = "Legal employee")]
    class Employee {
    ...
    }

    Quantifiers are also helpful in postconditions and preconditions. For example, a Fire method of the Department type might have the postcondition:

    [Postcondition("! exists (e in Employees: x == e)"]
    public void Fire(Employee e){...}

    A method, AnnounceMeeting, announces a meeting date but requires that the date will not be a holiday:

    [Precondition("forall (Date d in Date.Holidays : d != meetingDate")]
    public void AnnounceMeeting(Date meetingDate){...}

    The forthcoming iterator construct announced for C# will offer better support for these C#AL quantifiers.

    About Implementation
    The assembly Assertion Engine.dll contains all attribute types presented in the previous sections.

    An application can use an asserted assembly as any ordinary .NET assembly, ignoring the assertion attributes embedded in it. Nevertheless, an application can also retrieve and study these assertions for documentation purposes and can also evaluate them to monitor the behavior of the features targeted by the assertion attributes. For these purposes the AssertionEngine.dll includes the AssertionManager type. Using reflection, AssertionManager retrieves Assertion objects from the asserted assembly at runtime (the Assertion class implements IAssertion).

    But developers don't need to use the above capabilities programmatically. A browser tool (see Figure 1) allows selection of an assembly, and listing of the types, methods, and assertions in the assembly.

    The Documentation Panel generates an HTML file (Figure 2 illustrates the displayed HTML for the Stack type).

    The following is a typical scenario: you are developing an application using an asserted A.dll. You can use the C#AL browser to visualize the assertion attributes embedded in A.dll and check if they are correct. If you want to monitor the assertions, then you can use the "Build" button (see Figure 1) to generate a trusted assembly, Trusted_A.dll, which works as a proxy to the original A, intercepting calls to the asserted A methods and evaluating the code of the corresponding assertions. Finally, you must rebuild your project, removing the reference to A.dll and including references to the new Trusted_A.dll and to the AssertionEngine.dll. The resulting .exe file will monitor the assertion's fulfillment.

    Conclusion and Further Work
    Unfortunately the .NET Framework did not include an assertion mechanism from the outset. There is an Assert method in the Debug class, but it is not enough to achieve the specification goal of assertions.The Monash group is considering support assertions in the Rotor runtime.

    eXtensible C# (www.resolvecorp.com) includes declarative assertions. At present this approach is less expressive than C#AL.

    Moreover, the C#AL browser tool allows you to insert assertions in existing assemblies. We are also working on an implementation of assertions using CodeDom. In this case the Trusted_A.dll will not act as a proxy, but will embed its own A code.

    Assertions are not enough to completely guarantee a component's quality and behavior, according to Beugnard et al. in their article, "Making Components Contract Aware" [Computer, Vol. 32, No. 7]. Nevertheless, we hope that the proposed inclusion of assertion attributes in .NET will be a humble but important step toward the goal of a trusted component scenario.

    This article illustrates the significance of .NET attributes for metaprogramming. Combining attributes with assertions opens other research areas such as the specification of temporal constraints, component coordination, and synchronization of multithreading applications. We are exploring those areas. More contributions would be very welcome.

    References

  • Beugnard, A., Jézéquel, J.M., Plozeau, N., Watkins, D. (1999). "Making Components Contract Aware." Computer. July.
  • Coira, J., Katrib, M. (1997). "Improving Eiffel Assertions Using Quantified Iterators." Journal of Object Oriented Programming. Nov./Dec.
  • eXtensibleC# (XC#): www.resolvecorp.com
  • Design by Contract for Java Using JMSAssert: www.mmsindia.com/DBCForJava.html
  • Fernandez, D., Katrib, M., Pimentel, E. (1999). "Synchronizing Java Threads Using Assertions." Proceedings of TOOLS 31st. IEEE Computer Society.
  • Katrib, M., Martínez, I. (1993). "Collections and Iterators in Eiffel." Journal of Object Oriented Programming. Nov./Dec.
  • iContract: The Java Design by Contract Tool: Click Here!
  • Meyer, B. (1992). "Applying Design by Contract." Computer. IEEE. October.
  • Meyer, B. (1997). Object-Oriented Software Construction. 2nd Edition. Prentice Hall.
  • Meyer, B. (1992). Eiffel: The Language. Prentice Hall.
  • Java with Assertions: http://theoretica.informatik.uni-oldenburg.de/~jawa
  • Support for Assertions in the Rotor Runtime: www.csse.monash.edu.au/~namtt/rotor/MonashRotorProject.html
  • More Stories By Miguel Katrib

    Miguel Katrib is a PhD and a professor in the Computer Science Department at the University of Havana. He is also the head of the WEBOO group dedicated to Web and object-oriented technologies. Miguel is also a scientific advisor in .NET for the software enterprise CARE Technologies, Denia, Spain.

    More Stories By Erich Ledesma

    Erich Ledesma is an undergraduate and student assistant in the
    Computer Science Department at the University of Havana and is a
    student member of the WEBOO group. He has won several prizes in
    student competitions. Erich's main interests are compiling
    techniques, and network and Web programming.

    More Stories By Leonardo Paneque

    Leonardo Paneque is an undergraduate student in the Computer Science
    Department at the University of Havana and is a student member of the
    WEBOO group. His main interests are security, Windows, and GUI
    programming.

    Comments (0)

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


    @ThingsExpo Stories
    SYS-CON Events announced today that CAST Software will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. CAST was founded more than 25 years ago to make the invisible visible. Built around the idea that even the best analytics on the market still leave blind spots for technical teams looking to deliver better software and prevent outages, CAST provides the software intelligence that matter ...
    SYS-CON Events announced today that Daiya Industry will exhibit at the Japanese Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Ruby Development Inc. builds new services in short period of time and provides a continuous support of those services based on Ruby on Rails. For more information, please visit https://github.com/RubyDevInc.
    As businesses evolve, they need technology that is simple to help them succeed today and flexible enough to help them build for tomorrow. Chrome is fit for the workplace of the future — providing a secure, consistent user experience across a range of devices that can be used anywhere. In her session at 21st Cloud Expo, Vidya Nagarajan, a Senior Product Manager at Google, will take a look at various options as to how ChromeOS can be leveraged to interact with people on the devices, and formats th...
    SYS-CON Events announced today that Yuasa System will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Yuasa System is introducing a multi-purpose endurance testing system for flexible displays, OLED devices, flexible substrates, flat cables, and films in smartphones, wearables, automobiles, and healthcare.
    SYS-CON Events announced today that Taica will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Taica manufacturers Alpha-GEL brand silicone components and materials, which maintain outstanding performance over a wide temperature range -40C to +200C. For more information, visit http://www.taica.co.jp/english/.
    Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities – ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups. As a result, many firms employ new business models that place enormous impor...
    SYS-CON Events announced today that SourceForge has been named “Media Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. SourceForge is the largest, most trusted destination for Open Source Software development, collaboration, discovery and download on the web serving over 32 million viewers, 150 million downloads and over 460,000 active development projects each and every month.
    SYS-CON Events announced today that Dasher Technologies will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Dasher Technologies, Inc. ® is a premier IT solution provider that delivers expert technical resources along with trusted account executives to architect and deliver complete IT solutions and services to help our clients execute their goals, plans and objectives. Since 1999, we'v...
    As popularity of the smart home is growing and continues to go mainstream, technological factors play a greater role. The IoT protocol houses the interoperability battery consumption, security, and configuration of a smart home device, and it can be difficult for companies to choose the right kind for their product. For both DIY and professionally installed smart homes, developers need to consider each of these elements for their product to be successful in the market and current smart homes.
    SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
    SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
    SYS-CON Events announced today that TidalScale, a leading provider of systems and services, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. TidalScale has been involved in shaping the computing landscape. They've designed, developed and deployed some of the most important and successful systems and services in the history of the computing industry - internet, Ethernet, operating s...
    Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
    Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, will discuss how from store operations...
    In a recent survey, Sumo Logic surveyed 1,500 customers who employ cloud services such as Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). According to the survey, a quarter of the respondents have already deployed Docker containers and nearly as many (23 percent) are employing the AWS Lambda serverless computing framework. It’s clear: serverless is here to stay. The adoption does come with some needed changes, within both application development and operations. Tha...
    SYS-CON Events announced today that IBM has been named “Diamond Sponsor” of SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California.
    In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, will lead you through the exciting evolution of the cloud. He'll look at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering ...
    Infoblox delivers Actionable Network Intelligence to enterprise, government, and service provider customers around the world. They are the industry leader in DNS, DHCP, and IP address management, the category known as DDI. We empower thousands of organizations to control and secure their networks from the core-enabling them to increase efficiency and visibility, improve customer service, and meet compliance requirements.
    Join IBM November 1 at 21st Cloud Expo at the Santa Clara Convention Center in Santa Clara, CA, and learn how IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Cognitive analysis impacts today’s systems with unparalleled ability that were previously available only to manned, back-end operations. Thanks to cloud processing, IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Imagine a robot vacuum that becomes your personal assistant tha...
    With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.