# ResultSettings in new Session behaviour

**URL:** <https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774>\
**Category:** Technical\
**Created:** [July 11, 2022, 11:27am UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774 "2022-07-11T11:27:40Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![benstreek](https://avatars.discourse-cdn.com/v4/letter/b/bcef8e/32.png) [@benstreek](https://forum.opentap.io/u/benstreek)\
**Post date:** [July 11, 2022, 11:27am UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774/1 "2022-07-11T11:27:40Z")

</div>

Just returning to the software for [Parallel dynamic testplans - Technical - OpenTAP Community Forum](https://forum.opentap.io/t/parallel-dynamic-testplans/695/9) after some time working on other aspects of the project.

I was hoping to use a ResultListener to synchronize some unit tests of the concurrent runs, but `Session.Create()` doesn’t seem to clone the ResultSettings in the way I was expecting.

I’ve got a `ResultListener` defined in my test project as follows

```csharp
class SyncListener : ResultListener
{
    private readonly SyncMessageStore messageStore;
    private string dut;

    public SyncListener(SyncMessageStore syncMessageColletor)
    {
        this.messageStore = syncMessageColletor;
    }

    public override void OnTestPlanRunStart(TestPlanRun planRun)
    {
        base.OnTestPlanRunStart(planRun);
        dut = (new MacroString { Text = "<DUT>" }).Expand(planRun);
    }

    public override void OnTestStepRunStart(TestStepRun stepRun)
    {
        base.OnTestStepRunStart(stepRun);

        messageStore.ActiveTestName.AddOrUpdate(dut, stepRun.TestStepName, (key, oldVal) => stepRun.TestStepName);
    }

    public override void OnTestPlanRunCompleted(TestPlanRun planRun, Stream logStream)
    {
        base.OnTestPlanRunCompleted(planRun, logStream);
        messageStore.Complete.AddOrUpdate(dut, true, (key, oldVal) => true);
    }
}

```

An object to store the bits I want to capture from each test run, at the moment just the name of the test that’s running and if the run’s complete.

```csharp
class SyncMessageStore
{
    public ConcurrentDictionary<string, bool> Complete { get; } = new();
    public ConcurrentDictionary<string, string> ActiveTestName { get; } = new();
}

```

My test code (stripped down for brevity ) is something like this

```csharp
SyncMessageStore messageStore = new();
ResultSettings.Current.Add(new SyncListener(messageStore));

scanTargetSelecter.SelectScanTarget(Position.P01);
serialNumberProvider.SendSerialNumber("000000001"); // This kicks off the first test run

scanTargetSelecter.SelectScanTarget(Position.P02);
serialNumberProvider.SendSerialNumber("000000002"); // This kicks off the second test run

while (!messageStore.ActiveTestName.All(x => x.Value == "Wait")) { }
Thread.Sleep(50);

Assert.Equal("Waiting", singleViews[0].StatusText);
Assert.Equal("Waiting", singleViews[1].StatusText);

```

I have a test manager which deals with getting test plans, and starting runs etc.

```csharp
using (Session.Create(SessionOptions.RedirectLogging | SessionOptions.OverlayComponentSettings))
{
    TestPlan = testPlanProvider.GetTestPlanFromMaterialNumber(MaterialInfo.MaterialNumber);
    TestPlan.BreakOffered += TestPlan_BreakOffered;

    List<ResultListener> resultListeners = new(ResultSettings.Current.Cast<ResultListener>())
    {
        new SimpleListener(this),
        new LogResultListener() { FilePath = new MacroString() { Text = "TestRunLogs\\<Serial> <Date>.txt", Context = TestPlan } },
    };

    List<ResultParameter> metaDataParameters = new()
    {
        new("", "DUT", TestPosition, "DUT"),
        new("", "Serial", SerialNumber, "Serial")
    };
    
    CurrentRun = TestPlan.ExecuteAsync(resultListeners, metaDataParameters, null, CancellationToken.None);
}

```

I was expecting that using `OverlayComponentSettings` would give me a new instance of for ResultSettings.Current based off the one set up in the test but that doesn’t seem to be the case.

The API docs say about `OverlayComponentSettings `, “Component settings are cloned for the sake of this session. Instrument, DUT etc instances are cloned. When this is used, test plans should be reloaded in the new context.” Do ResultListeners not fall under “Instrument, DUT etc”?

---

<div class="post-metadata">

**Author:** ![rolf\_madsen](https://avatars.discourse-cdn.com/v4/letter/r/43a26b/32.png) [@rolf\_madsen](https://forum.opentap.io/u/rolf_madsen)\
**Post date:** [July 12, 2022, 2:06pm UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774/2 "2022-07-12T14:06:42Z")

</div>

ResultListeners does fall under ‘etc’

You say " I was expecting that using `OverlayComponentSettings` would give me a new instance of for ResultSettings.Current based off the one set up in the test but that doesn’t seem to be the case."

So you are saying that when you call `ResultSettings.Current`, it uses the same instances as before you created the new session?

---

<div class="post-metadata">

**Author:** ![benstreek](https://avatars.discourse-cdn.com/v4/letter/b/bcef8e/32.png) [@benstreek](https://forum.opentap.io/u/benstreek)\
**Post date:** [July 12, 2022, 5:59pm UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774/3 "2022-07-12T17:59:01Z")

</div>

Hi Rolf,  
No, it looks like it creates a new empty `ResultSettings`.  
Stepping through it, right before creating the new session, I queried the `ResultSettings` via the immediate window and got the following:

```csharp
ResultSettings.Current.Select(x => x.Name)
Count = 1
    [0]: "MyListener"

```

Then stepping into the using block and running again, I get

```csharp
ResultSettings.Current.Select(x => x.Name)
Exception thrown: 'System.Exception' in OpenTap.dll
Count = 0
    Empty: "Enumeration yielded no results"

```

I’m not sure what that exception is, I’ll try and investigate further.

But just so I understand correctly, I _should_ be seeing a single (new) instance of “MyListener” in that list, right?

---

<div class="post-metadata">

**Author:** ![rolf\_madsen](https://avatars.discourse-cdn.com/v4/letter/r/43a26b/32.png) [@rolf\_madsen](https://forum.opentap.io/u/rolf_madsen)\
**Post date:** [July 12, 2022, 8:42pm UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774/4 "2022-07-12T20:42:35Z")

</div>

OK, strange… Could you try saving the ResultSettings before creating the new session? It could be that we need to add some extra handling for unsaved setting modifications when creating the new session.

---

<div class="post-metadata">

**Author:** ![benstreek](https://avatars.discourse-cdn.com/v4/letter/b/bcef8e/32.png) [@benstreek](https://forum.opentap.io/u/benstreek)\
**Post date:** [July 13, 2022, 7:55am UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774/5 "2022-07-13T07:55:13Z")

</div>

I’ve been having a look this morning and here’s what I’ve come up with so far. Hopefully, it’ll help.

- Saving the `ResultsSettings` before creating the new `Session` had no effect. I got the same output in the Immediate Window.

- I tried adding to `InstrumentSettings`. This worked as expected, I had one instance of “SimpleInstrument” in `InstrumentSettings.Current` both before and after creating the `Session`. This was without saving.

- I tried adding to `ResultSettings`, saving, aborting the execution, re-running, and adding to `ResultSettings` again. I expected to see two instances of my `Listener`, but there was only the one I just added.

- Next I inspected `Results.xml`. It did have the `Listener` but I noticed the path was different from `Instruments.xml` (which seems to be working correctly).  
`bin\Debug\net5.0\Settings\Results.xml`  
`bin\Debug\net5.0\Settings\Bench\Default\Instruments.xml`  
Though this may well be correct, as the listeners probably wouldn’t change with different bench settings. I only mention it because it didn’t seem to have loaded from that file.

---

<div class="post-metadata">

**Author:** ![rolf\_madsen](https://avatars.discourse-cdn.com/v4/letter/r/43a26b/32.png) [@rolf\_madsen](https://forum.opentap.io/u/rolf_madsen)\
**Post date:** [July 13, 2022, 8:09am UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774/6 "2022-07-13T08:09:57Z")

</div>

This sounds like a bug to me. Can you open an issue on [Issues · opentap/opentap · GitHub](http://github.com/opentap/opentap/issues)?

---

<div class="post-metadata">

**Author:** ![benstreek](https://avatars.discourse-cdn.com/v4/letter/b/bcef8e/32.png) [@benstreek](https://forum.opentap.io/u/benstreek)\
**Post date:** [July 13, 2022, 5:04pm UTC](https://forum.opentap.io/t/resultsettings-in-new-session-behaviour/774/7 "2022-07-13T17:04:16Z")

</div>

[ComponentSettings not being cloned when creating new Session · Issue #710 · opentap/opentap (github.com)](https://github.com/opentap/opentap/issues/710)