Issue #7: migrate a test to using Test2::V0

and introducing subtests

Author: bschmalhofer

scripts/test/FAQ/RelatedArticle.t

@@ -21,11 +21,10 @@ use warnings;
 # core modules
 
 # CPAN modules
+use Test2::V0;
 
 # OTOBO modules
-use Kernel::System::UnitTest::RegisterDriver;    # Set up $Self and $Kernel::OM
-
-our $Self;
+use Kernel::System::UnitTest::RegisterDriver;    # Set up $Kernel::OM
 
 $Kernel::OM->ObjectParamAdd(
     'Kernel::System::UnitTest::Helper' => {
@@ -174,10 +173,7 @@ for my $FAQItem (@FAQItems) {
         %{$FAQItem},
     );
 
-    $Self->True(
-        $FAQItemID,
-        "FAQAdd() successful for test - FAQItemID $FAQItemID",
-    );
+    ok( $FAQItemID, "FAQAdd() successful for test - FAQItemID $FAQItemID" );
 
     push @FAQItemIDs, $FAQItemID;
 }
@@ -431,41 +427,30 @@ for my $Test (@Tests) {
     # check FAQKeywordArticleList attribute
     if ( !$Test->{FAQKeywordArticleList} || ref $Test->{FAQKeywordArticleList} ne 'HASH' ) {
 
-        $Self->True(
-            0,
-            "Test $TestCount: No FAQKeywordArticleList found for this test.",
-        );
+        fail("Test $TestCount: No FAQKeywordArticleList found for this test.");
 
         next TEST;
     }
 
-    # print test case description
-    if ( $Test->{Description} ) {
-        $Self->True(
-            1,
-            "Test $TestCount: $Test->{Description}",
-        );
-    }
+    subtest "Test $TestCount: $Test->{Description}" => sub {
 
-    my %FAQKeywordArticleList = $FAQObject->FAQKeywordArticleList(
-        %{ $Test->{FAQKeywordArticleList} },
-    );
-
-    if ( $Test->{Fails} ) {
-        $Self->False(
-            %FAQKeywordArticleList ? 1 : 0,
-            "Test $TestCount: FAQKeywordArticleList() - should fail.",
+        my %FAQKeywordArticleList = $FAQObject->FAQKeywordArticleList(
+            $Test->{FAQKeywordArticleList}->%*,
         );
-    }
-    else {
 
-        for my $Keyword ( sort keys %{ $Test->{ReferenceData} } ) {
+        if ( $Test->{Fails} ) {
+            ok( !%FAQKeywordArticleList, "Test $TestCount: FAQKeywordArticleList() - should fail." );
+        }
+        else {
 
-            $Self->IsDeeply(
-                $FAQKeywordArticleList{$Keyword} || [],
-                $Test->{ReferenceData}->{$Keyword},
-                "Test $TestCount: FAQKeywordArticleList() - $Keyword - test the result",
-            );
+            for my $Keyword ( sort keys %{ $Test->{ReferenceData} } ) {
+
+                is(
+                    $FAQKeywordArticleList{$Keyword} || [],
+                    $Test->{ReferenceData}->{$Keyword},
+                    "Test $TestCount: FAQKeywordArticleList() - $Keyword - test the result",
+                );
+            }
         }
     }
 }
@@ -504,14 +489,11 @@ my $LastFAQKeywordArticleListCache = $Kernel::OM->Get('Kernel::System::Cache')->
     Key  => $CacheKey,
 );
 
-$Self->True(
-    1,
-    "Test $TestCount: Test the cache for last function call",
-);
+diag("Test $TestCount: Test the cache for last function call");
 
 for my $Keyword ( sort keys %{ $Tests[-1]->{ReferenceData} } ) {
 
-    $Self->IsDeeply(
+    is(
         $LastFAQKeywordArticleListCache->{$Keyword} || [],
         $Tests[-1]->{ReferenceData}->{$Keyword},
         "Test $TestCount: Cache - FAQKeywordArticleList() - $Keyword - test the result",
@@ -803,10 +785,7 @@ for my $Test (@Tests) {
         )
     {
 
-        $Self->True(
-            0,
-            "Test $TestCount: No RelatedAgentArticleList or RelatedCustomerArticleList found for this test.",
-        );
+        fail("Test $TestCount: No RelatedAgentArticleList or RelatedCustomerArticleList found for this test.");
 
         next TEST;
     }
@@ -820,47 +799,37 @@ for my $Test (@Tests) {
         $RelatedArticleFunction = 'RelatedAgentArticleList';
     }
 
-    # print test case description
-    if ( $Test->{Description} ) {
-        $Self->True(
-            1,
-            "Test $TestCount: $Test->{Description}",
-        );
-    }
+    subtest "Test $TestCount: $Test->{Description}" => sub {
+        my @RelatedArticleList;
 
-    my @RelatedArticleList;
-
-    if ( $Test->{RelatedCustomerArticleList} ) {
-
-        @RelatedArticleList = $FAQObject->$RelatedArticleFunction(
-            %{ $Test->{RelatedCustomerArticleList} },
-        );
-    }
-    else {
-        @RelatedArticleList = $FAQObject->$RelatedArticleFunction(
-            %{ $Test->{RelatedAgentArticleList} },
-        );
-    }
+        if ( $Test->{RelatedCustomerArticleList} ) {
+            @RelatedArticleList = $FAQObject->$RelatedArticleFunction(
+                %{ $Test->{RelatedCustomerArticleList} },
+            );
+        }
+        else {
+            @RelatedArticleList = $FAQObject->$RelatedArticleFunction(
+                %{ $Test->{RelatedAgentArticleList} },
+            );
+        }
 
-    if ( $Test->{Fails} ) {
-        $Self->False(
-            @RelatedArticleList ? 1 : 0,
-            "Test $TestCount: $RelatedArticleFunction() - should fail.",
-        );
-    }
-    else {
+        if ( $Test->{Fails} ) {
+            ok( !@RelatedArticleList, "Test $TestCount: $RelatedArticleFunction() - should fail." );
+        }
+        else {
 
-        my @RelatedFAQArticleIDs = map { $_->{ItemID} } @RelatedArticleList;
+            my @RelatedFAQArticleIDs = map { $_->{ItemID} } @RelatedArticleList;
 
-        $Self->IsDeeply(
-            \@RelatedFAQArticleIDs,
-            $Test->{ReferenceData},
-            "Test $TestCount: $RelatedArticleFunction() - test the result",
-        );
+            is(
+                \@RelatedFAQArticleIDs,
+                $Test->{ReferenceData},
+                "Test $TestCount: $RelatedArticleFunction() - test the result",
+            );
+        }
     }
 }
 continue {
     $TestCount++;
 }
 
-$Self->DoneTesting();
+done_testing();