How to use UIComponentAccessChainScopeCache class of Atata package

Best Atata code snippet using Atata.UIComponentAccessChainScopeCache

AtataContext.cs

Source:AtataContext.cs

...354355        /// <summary>356        /// Gets the UI component access chain scope cache.357        /// </summary>358        public UIComponentAccessChainScopeCache UIComponentAccessChainScopeCache { get; } = new UIComponentAccessChainScopeCache();359360        /// <summary>361        /// Gets the object creator.362        /// </summary>363        public IObjectCreator ObjectCreator { get; internal set; }364365        /// <summary>366        /// Gets the object converter.367        /// </summary>368        public IObjectConverter ObjectConverter { get; internal set; }369370        /// <summary>371        /// Gets the object mapper.372        /// </summary>373        public IObjectMapper ObjectMapper { get; internal set; }374375        /// <summary>376        /// Gets the event bus, which can used to subscribe to and publish events.377        /// </summary>378        public IEventBus EventBus { get; internal set; }379380        /// <summary>381        /// Gets the variables dictionary.382        /// <para>383        /// The list of predefined variables:384        /// <list type="bullet">385        /// <item><c>build-start</c></item>386        /// <item><c>build-start-utc</c></item>387        /// <item><c>basedir</c></item>388        /// <item><c>artifacts</c></item>389        /// <item><c>test-name-sanitized</c></item>390        /// <item><c>test-name</c></item>391        /// <item><c>test-suite-name-sanitized</c></item>392        /// <item><c>test-suite-name</c></item>393        /// <item><c>test-start</c></item>394        /// <item><c>test-start-utc</c></item>395        /// <item><c>driver-alias</c></item>396        /// </list>397        /// </para>398        /// <para>399        /// Custom variables can be added as well.400        /// </para>401        /// </summary>402        public IDictionary<string, object> Variables { get; } = new Dictionary<string, object>();403404        /// <summary>405        /// Creates <see cref="AtataContextBuilder"/> instance for <see cref="AtataContext"/> configuration.406        /// Sets the value to <see cref="AtataContextBuilder.BuildingContext"/> copied from <see cref="GlobalConfiguration"/>.407        /// </summary>408        /// <returns>The created <see cref="AtataContextBuilder"/> instance.</returns>409        public static AtataContextBuilder Configure()410        {411            AtataBuildingContext buildingContext = GlobalConfiguration.BuildingContext.Clone();412            return new AtataContextBuilder(buildingContext);413        }414415        internal void InitDateTimeProperties()416        {417            StartedAtUtc = DateTime.UtcNow;418            StartedAt = TimeZoneInfo.ConvertTimeFromUtc(StartedAtUtc, TimeZone);419420            if (BuildStartUtc is null)421            {422                lock (s_buildStartSyncLock)423                {424                    if (BuildStartUtc is null)425                    {426                        BuildStartUtc = StartedAtUtc;427                        BuildStart = BuildStartUtc.Value.ToLocalTime();428                    }429                }430            }431432            BuildStartInTimeZone = TimeZoneInfo.ConvertTimeFromUtc(BuildStartUtc.Value, TimeZone);433        }434435        internal void InitMainVariables()436        {437            var variables = Variables;438439            variables["build-start"] = BuildStartInTimeZone;440            variables["build-start-utc"] = BuildStartUtc;441442            variables["basedir"] = AppDomain.CurrentDomain.BaseDirectory;443444            variables["test-name-sanitized"] = TestNameSanitized;445            variables["test-name"] = TestName;446            variables["test-suite-name-sanitized"] = TestSuiteNameSanitized;447            variables["test-suite-name"] = TestSuiteName;448            variables["test-start"] = StartedAt;449            variables["test-start-utc"] = StartedAtUtc;450451            variables["driver-alias"] = DriverAlias;452        }453454        internal void InitCustomVariables(IDictionary<string, object> customVariables)455        {456            var variables = Variables;457458            foreach (var variable in customVariables)459                variables[variable.Key] = variable.Value;460        }461462        internal void InitArtifactsVariable() =>463            Variables["artifacts"] = Artifacts.FullName.Value;464465        internal void LogTestStart()466        {467            StringBuilder logMessageBuilder = new StringBuilder(468                $"Starting {GetTestUnitKindName()}");469470            string[] testFullNameParts = GetTestFullNameParts().ToArray();471472            if (testFullNameParts.Length > 0)473            {474                logMessageBuilder.Append(": ")475                    .Append(string.Join(".", testFullNameParts));476            }477478            Log.Info(logMessageBuilder.ToString());479        }480481        private IEnumerable<string> GetTestFullNameParts()482        {483            if (TestSuiteType != null)484                yield return TestSuiteType.Namespace;485486            if (TestSuiteName != null)487                yield return TestSuiteName;488489            if (TestName != null)490                yield return TestName;491        }492493        private string GetTestUnitKindName()494        {495            return TestName != null496                ? "test"497                : TestSuiteType != null498                ? "test suite"499                : "test unit";500        }501502        /// <summary>503        /// Executes aggregate assertion using <see cref="AggregateAssertionStrategy" />.504        /// </summary>505        /// <param name="action">The action to execute in scope of aggregate assertion.</param>506        /// <param name="assertionScopeName">507        /// Name of the scope being asserted (page object, control, etc.).508        /// Is used to identify the assertion section in log.509        /// Can be null.510        /// </param>511        public void AggregateAssert(Action action, string assertionScopeName = null)512        {513            action.CheckNotNull(nameof(action));514515            AggregateAssertionStrategy.Assert(() =>516            {517                AggregateAssertionLevel++;518519                try520                {521                    Log.ExecuteSection(522                        new AggregateAssertionLogSection(assertionScopeName),523                        action);524                }525                finally526                {527                    AggregateAssertionLevel--;528                }529            });530        }531532        /// <summary>533        /// Cleans up the test context.534        /// </summary>535        /// <param name="quitDriver">if set to <see langword="true"/> quits WebDriver.</param>536        public void CleanUp(bool quitDriver = true)537        {538            if (_disposed)539                return;540541            PureExecutionStopwatch.Stop();542543            Log.ExecuteSection(544                new LogSection("Clean up AtataContext", LogLevel.Trace),545                () =>546                {547                    EventBus.Publish(new AtataContextCleanUpEvent(this));548549                    CleanUpTemporarilyPreservedPageObjectList();550551                    if (PageObject != null)552                        UIComponentResolver.CleanUpPageObject(PageObject);553554                    UIComponentAccessChainScopeCache.Release();555556                    if (quitDriver)557                        _driver?.Dispose();558                });559560            ExecutionStopwatch.Stop();561562            string testUnitKindName = GetTestUnitKindName();563            Log.InfoWithExecutionTimeInBrackets($"Finished {testUnitKindName}", ExecutionStopwatch.Elapsed);564            Log.InfoWithExecutionTime($"Pure {testUnitKindName} execution time:", PureExecutionStopwatch.Elapsed);565566            Log = null;567568            if (Current == this)
...

CheckBox`1.cs

Source:CheckBox`1.cs

...33            return Scope.Selected;34        }35        protected override void SetValue(bool value)36        {37            Context.UIComponentAccessChainScopeCache.ExecuteWithin(() =>38            {39                if (GetValue() != value)40                    OnClick();41            });42        }43        /// <summary>44        /// Checks the control.45        /// Also executes <see cref="TriggerEvents.BeforeSet" /> and <see cref="TriggerEvents.AfterSet" /> triggers.46        /// </summary>47        /// <returns>The owner page object.</returns>48        public TOwner Check()49        {50            return Set(true);51        }...

TypesTextUsingFocusBehaviorAndSendKeysAttribute.cs

Source:TypesTextUsingFocusBehaviorAndSendKeysAttribute.cs

...11        public override void Execute<TOwner>(IUIComponent<TOwner> component, string value)12        {13            if (!string.IsNullOrEmpty(value))14            {15                component.Context.UIComponentAccessChainScopeCache.ExecuteWithin(() =>16                {17                    component.ExecuteBehavior<FocusBehaviorAttribute>(x => x.Execute(component));18                    base.Execute(component, value);19                });20            }21        }22    }23}...