handled code rabbit suggestions

Ginger-Automation · Oct 28, 2024 · 656a1df · 656a1df
1 parent eb19a0f
commit 656a1df
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 141 deletions.
diff --git a/Ginger/Ginger/External/Katalon/KatalonConvertedPOMViewModel.cs b/Ginger/Ginger/External/Katalon/KatalonConvertedPOMViewModel.cs
@@ -1,6 +1,7 @@
 using amdocs.ginger.GingerCoreNET;
 using Amdocs.Ginger.Repository;
 using GingerCoreNET.SolutionRepositoryLib.RepositoryObjectsLib.PlatformsLib;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.Linq;
@@ -29,7 +30,7 @@ public string Name
             get => _name;
             set
             {
-                _name = value;
+                _name = value ?? string.Empty;
                 PropertyChanged?.Invoke(sender: this, new(nameof(Name)));
             }
         }
@@ -39,7 +40,7 @@ public string URL
             get => _url;
             set
             {
-                _url = value;
+                _url = value ?? string.Empty;
                 PropertyChanged?.Invoke(sender: this, new(nameof(URL)));
             }
         }
@@ -49,7 +50,7 @@ public string TargetApplication
             get => _targetApplication;
             set
             {
-                _targetApplication = value;
+                _targetApplication = value ?? string.Empty;
                 PropertyChanged?.Invoke(sender: this, new(nameof(TargetApplication)));
             }
         }
@@ -62,6 +63,8 @@ public string TargetApplication
 
         public KatalonConvertedPOMViewModel(ApplicationPOMModel pom, ePlatformType platform)
         {
+            ArgumentNullException.ThrowIfNull(pom);
+
             POM = pom;
             _active = true;
             _name = POM.Name;
@@ -73,23 +76,27 @@ public KatalonConvertedPOMViewModel(ApplicationPOMModel pom, ePlatformType platf
                 .Solution
                 .GetSolutionTargetApplications()
                 .Where(ta => GetApplicationPlatform(ta.Name) == platform)
-                .Select(ta => ta.Name);
+                .Select(ta => ta.Name)
+                .ToList();
         }
 
         private ePlatformType GetApplicationPlatform(string application)
         {
-            return
-                WorkSpace
-                .Instance
-                .Solution
-                .GetApplicationPlatformForTargetApp(application);
+            ArgumentException.ThrowIfNullOrEmpty(application);
+
+            if (WorkSpace.Instance?.Solution == null)
+            {
+                throw new InvalidOperationException("Workspace or Solution is not initialized");
+            }
+
+            return WorkSpace.Instance.Solution.GetApplicationPlatformForTargetApp(application);
         }
 
         public void CommitChanges()
         {
-            if (URL != null && !string.Equals(URL.Trim(), string.Empty))
+            if (!string.IsNullOrWhiteSpace(URL))
             {
-                POM.PageURL = URL;
+                POM.PageURL = URL.Trim();
             }
 
             ApplicationPlatform? appPlatform = WorkSpace.Instance

diff --git a/Ginger/Ginger/External/Katalon/SelectObjectRepositoryFolderWizardPage.xaml b/Ginger/Ginger/External/Katalon/SelectObjectRepositoryFolderWizardPage.xaml
@@ -12,9 +12,11 @@
         Background="{StaticResource $BackgroundColor_White}">
         <Grid.RowDefinitions>
             <RowDefinition
-                Height="auto" />
+                Height="auto"
+                MinHeight="30"/>
             <RowDefinition
-                Height="auto" />
+                Height="auto"
+                MinHeight="30"/>
         </Grid.RowDefinitions>
         <Grid.ColumnDefinitions>
             <ColumnDefinition
@@ -24,19 +26,21 @@
         </Grid.ColumnDefinitions>
         <Label
             Style="{StaticResource @InputFieldLabelStyle}"
-            Content="Select Katalon Object-Repositoy Folder" />
+            Content="Select Katalon Object-Repository Folder" />
         <TextBox
             x:Name="DirectoryTextBox"
             Grid.Row="1"
             Grid.Column="0"
-            Style="{StaticResource $TextBoxStyle}"/>
+            Style="{StaticResource $TextBoxStyle}"
+            ToolTip="Enter or browse for the Katalon Object Repository folder location" />
         <Button
             x:Name="DirectoryBrowseButton"
             Grid.Row="1"
             Grid.Column="1"
             Content="Browse"
             VerticalAlignment="Center"
             Style="{StaticResource $InputButtonStyle}"
-            Click="DirectoryBrowseButton_Click" />
+            Click="DirectoryBrowseButton_Click"
+            ToolTip="Click to browse and select the Katalon Object Repository folder" />
     </Grid>
 </Page>
diff --git a/Ginger/Ginger/External/Katalon/SelectObjectRepositoryFolderWizardPage.xaml.cs b/Ginger/Ginger/External/Katalon/SelectObjectRepositoryFolderWizardPage.xaml.cs
@@ -1,6 +1,7 @@
 using Amdocs.Ginger.Common;
 using GingerCore.GeneralLib;
 using GingerWPF.WizardLib;
+using System;
 using System.IO;
 using System.Windows;
 using System.Windows.Controls;
@@ -16,6 +17,11 @@ public partial class SelectObjectRepositoryFolderWizardPage : Page, IWizardPage
 
         public SelectObjectRepositoryFolderWizardPage(ImportKatalonObjectRepositoryWizard wizard)
         {
+            if (wizard == null)
+            {
+                throw new ArgumentNullException(nameof(wizard));
+            }
+
             InitializeComponent();
 
             _wizard = wizard;
@@ -27,16 +33,16 @@ public void WizardEvent(WizardEventArgs e)
             switch (e.EventType)
             {
                 case EventType.LeavingForNextPage:
-                    if (_wizard.SelectedDirectory == null || string.Equals(_wizard.SelectedDirectory.Trim(), string.Empty))
+                    if (string.IsNullOrWhiteSpace(_wizard.SelectedDirectory))
                     {
                         e.CancelEvent = true;
-                        Reporter.ToUser(eUserMsgKey.InvalidKatalonObjectRepository, "Folder path is empty");
+                        Reporter.ToUser(eUserMsgKey.InvalidKatalonObjectRepository, "Please select a folder containing Katalon Object Repository files.");
                         break;
                     }
-                    if (!Directory.Exists(_wizard.SelectedDirectory))
+                    if (!Directory.Exists(_wizard.SelectedDirectory.Trim()))
                     {
                         e.CancelEvent = true;
-                        Reporter.ToUser(eUserMsgKey.InvalidKatalonObjectRepository, "Folder doesn't exist");
+                        Reporter.ToUser(eUserMsgKey.InvalidKatalonObjectRepository, $"The selected folder does not exist.");
                         break;
                     }
                     break;

diff --git a/Ginger/GingerCoreNET/External/Katalon/Conversion/KatalonElementToElementInfoConverter.cs b/Ginger/GingerCoreNET/External/Katalon/Conversion/KatalonElementToElementInfoConverter.cs
@@ -6,22 +6,37 @@ namespace Amdocs.Ginger.CoreNET.External.Katalon.Conversion
 {
     internal static class KatalonElementToElementInfoConverter
     {
+        /// <summary>
+        /// Converts a collection of Katalon elements to Ginger ElementInfo objects.
+        /// </summary>
+        /// <param name="katalonElementList">The list of Katalon elements to convert.</param>
+        /// <returns>A collection of converted ElementInfo objects.</returns>
+        /// <exception cref="System.ArgumentNullException">Thrown when katalonElementList is null.</exception>
         internal static IEnumerable<ElementInfo> Convert(IEnumerable<KatalonElementEntity> katalonElementList)
         {
+            if (katalonElementList == null)
+            {
+                throw new System.ArgumentNullException(nameof(katalonElementList));
+            }
+
+            if (!katalonElementList.Any())
+            {
+                return Enumerable.Empty<ElementInfo>();
+            }
+
             List<ElementInfo> elementInfoList = [];
 
+            var katalonWebElementList = katalonElementList
+                .OfType<KatalonWebElementEntity>()
+                .ToList();
+
             foreach (KatalonElementEntity katalonElement in katalonElementList)
             {
-                IEnumerable<KatalonWebElementEntity> katalonWebElementList = katalonElementList
-                .Where(e => e is KatalonWebElementEntity)
-                .Cast<KatalonWebElementEntity>();
-
                 if (katalonElement is KatalonWebElementEntity katalonWebElement)
                 {
                     elementInfoList.Add(katalonWebElement.ToElementInfo(katalonWebElementList));
                 }
             }
-
             return elementInfoList;
         }
     }

diff --git a/Ginger/GingerCoreNET/External/Katalon/Conversion/KatalonObjectRepositoryToPOMConverter.cs b/Ginger/GingerCoreNET/External/Katalon/Conversion/KatalonObjectRepositoryToPOMConverter.cs
@@ -167,7 +167,7 @@ internal static bool HasPOMWithName(string name)
         }
 
         /// <summary>
-        /// Get all the Rust files (.rs) in <paramref name="directory"/>.
+        /// Get all the Rust Source files (.rs) in <paramref name="directory"/>.
         /// </summary>
         /// <returns>Collection of paths of all the Rust files (.rs).</returns>
         private static IEnumerable<string> GetKatalonObjectFilesInDirectory(string directory)

diff --git a/Ginger/GingerCoreNET/External/Katalon/Conversion/KatalonWebElementEntity.cs b/Ginger/GingerCoreNET/External/Katalon/Conversion/KatalonWebElementEntity.cs
@@ -368,7 +368,7 @@ private IEnumerable<ElementLocator> GetLocators()
                 locators.Add(new()
                 {
                     Active = true,
-                    LocateBy = eLocateBy.ByID,
+                    LocateBy = eLocateBy.ByName,
                     LocateValue = nameProperty.Value,
                     IsAutoLearned = true, //static
                 });

diff --git a/...CoreNETUnitTest/External/Katalon/Conversion/KatalonObjectRepositoryToPOMConverterTests.cs b/...CoreNETUnitTest/External/Katalon/Conversion/KatalonObjectRepositoryToPOMConverterTests.cs
diff --git a/Ginger/GingerCoreNETUnitTest/GingerCoreNETUnitTest.csproj b/Ginger/GingerCoreNETUnitTest/GingerCoreNETUnitTest.csproj
@@ -100,6 +100,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <Folder Include="External\Katalon\Conversion\" />
     <Folder Include="TestResources\Conversion\" />
     <Folder Include="TestResources\Solutions\EmailWebReport\HTMLReportConfigurations\HTMLReportTemplate\" />
     <Folder Include="TestResources\Solutions\EmailWebReport\HTMLReportConfigurations\ReportTemplates\" />