Tests for Graph controller index method

CHANGELOG.md

@@ -65,6 +65,7 @@
 - Switched connection for timetable parsing from `RequireEMS` to `AllowEMS`
 - Fixed dependency caching in CircleCI configuration
 - Added dependency groups to Dependabot configuration
+- Added tests for the index function in `Controllers/Graph`
 
 ## [0.6.0] - 2024-06-24
 

README.md

@@ -115,6 +115,7 @@ Ross Gatih,
 Nazanin Ghazitabatabai,
 Sidharth Gupta,
 Parker Hutcheson,
+Yoonie Jang,
 Jai Joshi,
 Aayush Karki,
 Philip Kukulak,

backend-test/Controllers/ControllerTests.hs

@@ -9,8 +9,10 @@ module Controllers.ControllerTests
 (  controllerTests  ) where
 
 import Test.HUnit (Test (..))
+
 import Controllers.CourseControllerTests (courseControllerTestSuite)
+import Controllers.GraphControllerTests (graphControllerTestSuite)
 
 -- Single test encompassing all controller test suites
 controllerTests :: Test
-controllerTests = TestList [courseControllerTestSuite]
+controllerTests = TestList [courseControllerTestSuite, graphControllerTestSuite]

backend-test/Controllers/GraphControllerTests.hs

@@ -0,0 +1,63 @@
+{-|
+Description: Graph Controller module tests.
+
+Module that contains the tests for the functions in the Graph Controller module.
+
+-}
+
+module Controllers.GraphControllerTests
+( graphControllerTestSuite
+) where
+
+import Config (runDb)
+import Controllers.Graph (index)
+import qualified Data.ByteString.Lazy.Char8 as BL
+import qualified Data.Text as T
+import Database.Persist.Sqlite (SqlPersistM, insert_)
+import Database.Tables (Graph (..))
+import Happstack.Server (rsBody)
+import Test.HUnit (Test (..), assertEqual)
+import TestHelpers (clearDatabase, runServerPart)
+
+-- | List of test cases as (label, input graphs, expected output)
+indexTestCases :: [(String, [T.Text], String)]
+indexTestCases =
+    [ ("No graphs",
+        [],
+        "[]"
+    ),
+
+    ("One graph",
+        ["Statistics"],
+        "[{\"dynamic\":false,\"height\":0,\"id\":1,\"title\":\"Statistics\",\"width\":0}]"
+    ),
+
+    ("Multiple graphs",
+        ["Computer Science", "Statistics", "Physics"],
+        "[{\"dynamic\":false,\"height\":0,\"id\":1,\"title\":\"Computer Science\",\"width\":0},{\"dynamic\":false,\"height\":0,\"id\":3,\"title\":\"Physics\",\"width\":0},{\"dynamic\":false,\"height\":0,\"id\":2,\"title\":\"Statistics\",\"width\":0}]"        )
+    ]
+
+-- | Helper function to insert graphs into the database
+insertGraphs :: [T.Text] -> SqlPersistM ()
+insertGraphs = mapM_ insertGraph
+    where
+        insertGraph title = insert_ (Graph title 0 0 False )
+
+-- | Run a test case (case, input, expected output) on the index function.
+runIndexTest :: String -> [T.Text] -> String -> Test
+runIndexTest label graphs expected =
+    TestLabel label $ TestCase $ do
+        runDb $ do
+            clearDatabase
+            insertGraphs graphs
+        response <- runServerPart Controllers.Graph.index
+        let actual = BL.unpack $ rsBody response
+        assertEqual ("Unexpected response body for " ++ label) expected actual
+
+-- | Run all the index test cases
+runIndexTests :: [Test]
+runIndexTests = map (\(label, graphs, expected) -> runIndexTest label graphs expected) indexTestCases
+
+-- | Test suite for Graph Controller Module
+graphControllerTestSuite :: Test
+graphControllerTestSuite = TestLabel "Graph Controller tests" $ TestList runIndexTests

courseography.cabal

@@ -24,6 +24,8 @@ library
   exposed-modules:
     Config,
     Controllers.Course,
+    Controllers.Graph,
+    Css.Constants,
     Database.CourseInsertion,
     Database.CourseQueries,
     Database.CourseVideoSeed,
@@ -32,9 +34,17 @@ library
     Database.Requirement,
     Database.Tables,
     DynamicGraphs.GraphNodeUtils,
+    Export.GetImages,
+    Export.ImageConversion,
+    Export.TimetableImageCreator,
+    MasterTemplate,
+    Response.Image,
+    Scripts,
     Svg.Builder,
     Svg.Database,
+    Svg.Generator,
     Svg.Parser,
+    Util.Blaze,
     Util.Happstack,
     WebParsing.ArtSciParser,
     WebParsing.ParsecCombinators,
@@ -43,23 +53,32 @@ library
   build-depends:
     aeson,
     base >=4.14,
+    base64-bytestring,
+    blaze-html,
+    blaze-markup,
+    blaze-svg,
     bytestring,
     Cabal >= 1.16.0,
     containers,
     crypton-connection,
     data-default-class,
     directory,
+    diagrams-lib,
+    diagrams-svg,
     happstack-server,
     hlint,
     hslogger,
     http-conduit,
     http-types,
     MissingH,
+    markdown,
     monad-logger,
     mtl,
     parsec,
     persistent,
     persistent-sqlite,
+    process,
+    random,
     resourcet,
     split,
     system-filepath,
@@ -83,6 +102,7 @@ test-suite Tests
   other-modules:
     Controllers.ControllerTests,
     Controllers.CourseControllerTests,
+    Controllers.GraphControllerTests,
     RequirementTests.ModifierTests,
     RequirementTests.PostParserTests,
     RequirementTests.PreProcessingTests,