topic Re: UnitTesting and ArcObjects 10 in ArcObjects SDK Questions

UnitTesting and ArcObjects 10

YvoWeidmann — Wed, 31 Aug 2011 08:34:33 GMT

Dear List

I am trying to use UnitTests with the provided framework within VisualStudio 2010 and ArcGIS (ArcEditor) with C#.

The main problem seems the initializing of the ArcObjects. As soon as I am using an ArcObject object in a test method the following exception is thrown:
System.Runtime.InteropServices.InvalidComObjectException: COM object that has been separated from its underlying RCW cannot be used.

As first I initialize the ArcObjects environment with a test method defined as [AssemblyInitialize]:
-----------------------------
private static AoInitialize aoInitialize;
[AssemblyInitialize]
public static void AssemblyInitialize(TestContext context) {
RuntimeManager.BindLicense(ProductCode.EngineOrDesktop);
aoInitialize = new AoInitializeClass();
aoInitialize.Initialize(esriLicenseProductCode.esriLicenseProductCodeArcEditor);
}
-----------------------------

The license is correctly checked out. But as mentioned, ArcObjects-based objects are throwing the InvalidComObjectException.

I tried several ways of initializing, but till now unsuccessfully.

Does anyone has an idea? I am looking for any hint.

Best regards,
Yvo

Re: UnitTesting and ArcObjects 10

JohnHauck — Fri, 02 Sep 2011 17:49:20 GMT

I've not done much in the way of tests and haven't looked at this one in particular but wanted to share some things that I have seen in the past related to this. I know with VS 2008 by default Unit Test projects were set to execute in MTA mode. All ArcObjects components are marked as single threaded apartment (STA). STAs are limited to one thread each. So you needed to change the mode to STA. Also setting the runtime configuration manager to x86 may have an impact if you are running on a 64 bit system. Prior to VS 2010 SP1 new test projects would always target .NET 4.0 even if 3.5 was set in the new project dialog. .NET 4.0 won't be officially supported by ESRI until the ArcGIS 10.1 release. I would suggest that you also install SP1 for VS 2010 so you can properly target .NET 3.5.

I hope this helps!

Re: UnitTesting and ArcObjects 10

RichardWatson — Fri, 02 Sep 2011 18:48:11 GMT

I use ArcObjects inside integration tests I have written using Visual Studio 2010 SP1 using the built-in C# unit test framework. What I do is to initialize ArcObjects as part of the test, i.e. I have not tried any assembly level initialization.

I don't have the code in front of me but I think that I did use an attribute to try and force STA.

Oh, and I am using 9.3.1 but I would not think that that would make a difference (other than having to bind to a version).

If you send me an email then I'll send you a code snippet when I get back to the office next Tuesday. rwatson at telcoridia dot com.

Re: UnitTesting and ArcObjects 10

MelitaKennedy — Fri, 02 Sep 2011 18:51:07 GMT

If you email him, use telcordia, not telcoridia!

Re: UnitTesting and ArcObjects 10

YvoWeidmann — Mon, 05 Sep 2011 04:47:08 GMT

Hi

That sounds very reasonble:

So you needed to change the mode to STA.

Thank you very much for the hint.

But I was looking for the "switch" to change to STA. Can you give me another hint, how to do it.

Thank you very much,
Yvo

Re: UnitTesting and ArcObjects 10

JohnHauck — Tue, 06 Sep 2011 15:15:00 GMT

Here is a Microsoft article that talks about how to Run Unit Tests in MTA mode. You would just want to use STA instead.

Re: UnitTesting and ArcObjects 10

RichardWatson — Thu, 13 Oct 2011 00:48:04 GMT

Configure Visual Studio to use MTA. The tests are run on different threads and ArcObjects do not handle this well.

Re: UnitTesting and ArcObjects 10

BKuiper — Wed, 01 Aug 2012 17:35:21 GMT

I'm having similar problems with 10.1 (final release) and unit testing of ArcObject code. The license retrieval and usage is causing problems. Anybody found a proper way to initialize the license and keep it active during the tests while running the geoprocessor and arcobjects tools in STA ? I tried different things but haven't found a solution so far. Any tips or tricks would be helpful.

Re: UnitTesting and ArcObjects 10

MannusEtten — Fri, 17 Aug 2012 11:20:19 GMT

so after a while nobody has a solution?

Nobody got a reply from Esri. Inc?
I am struggling with the issue too...

Re: UnitTesting and ArcObjects 10

AlexanderGray — Fri, 17 Aug 2012 13:39:20 GMT

I use VS2008 but I put the AO license and product initialization in the ClassInitialize method of the test class with the appropriate method decorator. I have never done it in the Assembly initialize method.

Re: UnitTesting and ArcObjects 10

LukeBadgerow — Fri, 10 Dec 2021 21:24:00 GMT

I don't believe that this is related to the STA/MTA portion of this issue

(sorry for the bump, but this looks like the most directly related Unit Testing thread across the forums)

I'm getting hit by the following error every time I run into anything that initially sits in the ESRI.ArcGIS.esriSystem package (specifically UID/UIDClass and IPropertySet). This will happen regardless of whether or not I attempt to access through a mocking framework (I'm currently using Rhino Mocks):

Warning: Test Run deployment issue: The assembly or module 'ESRI.DADF.Core' directly or indirectly referenced by the container 'C:\[MyArcGISAddinDeploymentDirectory]\editorassisttests.dll' was not found.

I have been working through the process of refactoring as much of my code to NOT use AO as much as possible, in the expectation that I could reach a target of around 80% code coverage (unit/integration test combo). But getting IEditor and IFeatureWorkspace are kind of tough to avoid. If anyone has any guidance, I'd gladly accept all the help I can get. I'm fairly new to Unit Testing, and trying to learn it in the wild by translating java examples across to AO is a little bit of a brain drain. Below are a couple code examples of simple situations that I'm using to just verify that I can get these "things".

        [TestMethod()]
        public void CheckLayoutView_ReturnsIFeatureWorkspaceType () {
            MockRepository mockrepo = new MockRepository();

            IPlotDocument plotter = mockrepo.DynamicMock<PlotDocumentGeneratorClass>();
            IFeatureWorkspace transworkspace = plotter.SetCurrentWorkspace();
            Assert.IsInstanceOfType(transworkspace, typeof(ESRI.ArcGIS.Geodatabase.IFeatureWorkspace));
        }
        [TestMethod()]
        public void GetEditor_MockingTest () {
            MockRepository mockrepo = new MockRepository();
            PlotDocumentGeneratorClass plotter = new PlotDocumentGeneratorClass();
            UID test = mockrepo.StrictMock<UID>();
            Assert.IsNotNull(test);

        }
        [TestMethod()]
        public void GetWorkspace_ReturnsNotNull () {
            PlotDocumentGeneratorClass plotter = new PlotDocumentGeneratorClass();
            IFeatureWorkspace ws = plotter.GetWorkspace("LBADGEROW", "C:\\", false);
            Assert.IsNotNull(ws);
        }

Re: UnitTesting and ArcObjects 10

RichardWatson — Mon, 20 Aug 2012 13:30:47 GMT

I don't have 10.0 installed at the moment.

Where is ESRI.DADF.Core on your system?

Suggest that you run fuslogvw to see why the references assembly was not found.

How does your project reference this assembly?

Re: UnitTesting and ArcObjects 10

LukeBadgerow — Fri, 10 Dec 2021 21:24:02 GMT

Thanks for the quick response! Here is where I'm at now:

I was also receiving a warning that I was neglecting to address (I've currently also got a separate issue where the addin cannot access our SOA upon deployment) that was suggesting that I switch the Embed Interop Types property to false on the AO packages for the [testing] project. Once I did that I was able to at least create mock AO instances (UIDClass, IPropertySet2, IApplication). With a little bit of refactoring I am able to pass the Mock instances of UIDClass and IApplication into the method that I'm attempting to test, but I'm currently working through setting the "esriEditor.Editor" Value to my mock UIDClass correctly

        public IEditor GetEditor (UID uid, IApplication app) {
            IEditor editor = null;
            editor = app.FindExtensionByCLSID(uid) as IEditor;
            return editor;
        }

        [TestMethod()]
        public void GetEditor_MockingTest () {
            MockRepository mockrepo = new MockRepository();
            PlotDocumentGeneratorClass plotter = new PlotDocumentGeneratorClass();

            UID testuid = mockrepo.StrictMockWithRemoting<UIDClass>();
            testuid.Value = "esriEditor.Editor";
            IApplication testapp = mockrepo.StrictMock<IApplication>();
            IEditor testeditor = plotter.GetEditor(testuid, testapp);

            Assert.IsNotNull(testeditor);
        }

Re: UnitTesting and ArcObjects 10

MannusEtten — Fri, 24 Aug 2012 11:22:49 GMT

which mocking-framework do you use Luke?

So when I do AOInitialize at classinitiliaze i am rid of my problems?

Re: UnitTesting and ArcObjects 10

LukeBadgerow — Fri, 09 Nov 2012 14:05:37 GMT

which mocking-framework do you use Luke?

So when I do AOInitialize at classinitiliaze i am rid of my problems?

Apologies for the long delay in responding. Currently I'm using Rhino Mocks, but as I expand my unit/integration tests for this group of projects, I'm starting to run into a few issues (Namely with building my MSTest project on a deployment server) and am starting to contemplate switching all of that architecture up.

I haven't run AOInitialize as yet. I have previously been attempting to keep as much AO logic from bleeding into my testing work as possible. Considering I'm trying to test business logic, and am often disconnected from my license server, it's beneficial for me to isolate out the AO as much as possible. I will fire up some tests with it though and get back with you.