Add tests for SpecialOutput.

Author: chungyc

src/SpecialOutput.hs

@@ -140,7 +140,7 @@ toAnnotation v = do
     ruleId _ = Nothing
 
 -- | Returns the annotations for the location in a result object.
--- If there are any location annotations, the return value will end with @", "@,
+-- If there are any location annotations, the return value will end with @","@,
 -- otherwise the return value will be empty.
 locationAnnotation :: Object -> Text
 locationAnnotation v =
@@ -153,23 +153,23 @@ locationAnnotation v =
     ]
   where
     fileAnnotation
-      | (Just s) <- filename = "file=" <> escapeSpecial s <> ", "
+      | (Just s) <- filename = "file=" <> escapeSpecial s <> ","
       | otherwise = ""
 
     colAnnotation
-      | (Just n) <- col = "col=" <> pack (show n) <> ", "
+      | (Just n) <- col = "col=" <> pack (show n) <> ","
       | otherwise = ""
 
     endColumnAnnotation
-      | (Just n) <- endColumn = "endColumn=" <> pack (show n) <> ", "
+      | (Just n) <- endColumn = "endColumn=" <> pack (show n) <> ","
       | otherwise = ""
 
     lineAnnotation
-      | (Just n) <- line = "line=" <> pack (show n) <> ", "
+      | (Just n) <- line = "line=" <> pack (show n) <> ","
       | otherwise = ""
 
     endLineAnnotation
-      | (Just n) <- endLine = "endLine=" <> pack (show n) <> ", "
+      | (Just n) <- endLine = "endLine=" <> pack (show n) <> ","
       | otherwise = ""
 
     locations

test/SpecialOutputSpec.hs

@@ -19,10 +19,46 @@ limitations under the License.
 -- Copyright: Copyright 2025 Google LLC
 -- License: Apache-2.0
 -- Maintainer: [email protected]
-module SpecialOutputSpec (spec) where
+module SpecialOutputSpec where
 
+import Data.Aeson
+import Data.Aeson.KeyMap qualified as KeyMap
+import Data.Vector qualified as Vector
+import SpecialOutput
+import System.Exit
 import Test.Hspec
 
 spec :: Spec
 spec = parallel $ do
-  it "is pending" pending
+  it "outputs minimal annotation" $
+    let v = encode $ Object $ KeyMap.singleton "runs" runs
+        runs = Array $ Vector.singleton run
+        run = Object $ KeyMap.singleton "results" results
+        results = Array $ Vector.singleton result
+        result =
+          Object $
+            KeyMap.fromList
+              [ ("level", "error"),
+                ("ruleId", "redundant entity"),
+                ("message", Object $ KeyMap.singleton "text" "random comment")
+              ]
+     in output Never v `shouldBe` ("::error title=redundant entity::random comment\n", ExitSuccess)
+
+  it "outputs annotation with some location information" $
+    let v = encode $ Object $ KeyMap.singleton "runs" runs
+        runs = Array $ Vector.singleton run
+        run = Object $ KeyMap.singleton "results" results
+        results = Array $ Vector.singleton result
+        result =
+          Object $
+            KeyMap.fromList
+              [ ("level", "error"),
+                ("ruleId", "redundant entity"),
+                ("message", Object $ KeyMap.singleton "text" "random comment"),
+                ("locations", Array $ Vector.singleton location)
+              ]
+        location = Object $ KeyMap.singleton "physicalLocation" physicalLocation
+        physicalLocation = Object $ KeyMap.singleton "artifactLocation" artifactLocation
+        artifactLocation = Object $ KeyMap.singleton "uri" "SpecialOutput.hs"
+     in output Never v
+        `shouldBe` ("::error file=SpecialOutput.hs,title=redundant entity::random comment\n", ExitSuccess)