CodeContracts: Possibly calling a method on a null reference
CodeContracts is right. There is nothing stopping you from setting instance.bar = null
prior to calling the BarLength()
method.
Your code includes a private static initialized instance:
private static Foo instance = new Foo();
Are you assuming that this means the instance constructor will always have run before access to any static method, therefore ensuring bar
has been initialized?
In the single threaded case, I think you're right.
The sequence of events would be:
- Call to
Foo.BarLength()
- Static initialization of class
Foo
(if not already completed) - Static initialization of private static member
instance
with instance ofFoo
- Entry to
Foo.BarLength()
However, static initialization of a class is only ever triggered once per App Domain - and IIRC there's no blocking to ensure it's completed before any other static methods are called.
So, you could have this scenario:
- Thread Alpha: Call to
Foo.BarLength()
- Thread Alpha: Static initialization of class
Foo
(if not already completed) starts - Context Switch
- Thread Beta: Call to
Foo.BarLength()
- Thread Beta: No Call to static initialization of class
Foo
because that's already underway - Thread Beta: Entry to
Foo.BarLength()
- Thread Beta: Access to
null
static memberinstance
There's no way the Contracts analyser can know that you'd never run the code in a multithreaded way, so it has to err on the side of caution.
Update: It seems the problem is that invariants are not supported for static fields.
2nd Update: The method outlined below is currently the recommended solution.
A possible workaround is to create a property for instance
that Ensure
s the invariants that you want to hold. (Of course, you need to Assume
them for the Ensure
to be proven.) Once you have done this, you can just use the property and all the invariants should be proven correctly.
Here's your example using this method:
class Foo
{
private static readonly Foo instance = new Foo();
private readonly string bar;
public static Foo Instance
// workaround for not being able to put invariants on static fields
{
get
{
Contract.Ensures(Contract.Result<Foo>() != null);
Contract.Ensures(Contract.Result<Foo>().bar != null);
Contract.Assume(instance.bar != null);
return instance;
}
}
public Foo()
{
Contract.Ensures(bar != null);
bar = "Hello world!";
}
public static int BarLength()
{
Contract.Assert(Instance != null);
Contract.Assert(Instance.bar != null);
// both of these are proven ok
return Instance.bar.Length;
}
}