[TSD-18] Add simple tests (#14)

* [CO-289] Add simple tests, pending tests.

* [CO-289] Working first version.

* [CO-289] Working simple tests, ongoing refactoring to try to increase testability.

* [CO-289] Working simple tests, along with top level functions.

* [CO-289] Fixed review comments.

Author: ksaric

log-classifier.cabal

@@ -42,6 +42,7 @@ library
                      , text
                      , universum
                      , zip-archive
+                     , QuickCheck
 
   default-language:    Haskell2010
   default-extensions: TypeOperators
@@ -67,7 +68,8 @@ library
 executable log-classifier-exe
   hs-source-dirs:      app
   main-is:             Main.hs
-  ghc-options:         -threaded -rtsopts -with-rtsopts=-N
+  ghc-options:         -threaded 
+                       -rtsopts -with-rtsopts=-N
                        -Wall
   build-depends:       base >=4.7 && <5
                      , log-classifier
@@ -99,7 +101,6 @@ test-suite log-classifier-test
   type:                exitcode-stdio-1.0
   main-is:             Spec.hs
   ghc-options:         -Wall
-  other-modules:       Paths_log_classifier
   build-depends:       aeson
                      , array
                      , attoparsec
@@ -114,6 +115,8 @@ test-suite log-classifier-test
                      , text
                      , universum
                      , zip-archive
+                     , QuickCheck
+                     , hspec
 
   default-language:    Haskell2010
   default-extensions: TypeOperators
@@ -131,6 +134,6 @@ test-suite log-classifier-test
                       TemplateHaskell
                       RecordWildCards
                       ScopedTypeVariables
-                      UndecidableInstances
                       MonadFailDesugaring
                       TupleSections
+

src/Lib.hs

@@ -9,6 +9,8 @@ module Lib
     , processTickets
     , fetchTickets
     , showStatistics
+
+    , listAndSortTickets
     ) where
 
 import           Universum
@@ -23,10 +25,11 @@ import           LogAnalysis.Classifier (extractErrorCodes, extractIssuesFromLog
 import           LogAnalysis.KnowledgeCSVParser (parseKnowLedgeBase)
 import           LogAnalysis.Types (ErrorCode (..), Knowledge, renderErrorCode, setupAnalysis)
 import           Util (extractLogsFromZip)
-import           Zendesk (App, Attachment (..), Comment (..), Config (..), RequestType (..),
-                          TicketId, TicketInfo (..), TicketTag (..), ZendeskLayer (..),
-                          ZendeskResponse (..), asksZendeskLayer, assignToPath, defaultConfig,
-                          knowledgebasePath, renderTicketStatus, runApp, tokenPath)
+import           Zendesk (App, Attachment (..), Comment (..), Config (..), IOLayer (..),
+                          RequestType (..), TicketId, TicketInfo (..), TicketTag (..),
+                          ZendeskLayer (..), ZendeskResponse (..), asksIOLayer, asksZendeskLayer,
+                          assignToPath, defaultConfig, knowledgebasePath, renderTicketStatus,
+                          runApp, tokenPath)
 
 ------------------------------------------------------------
 -- Functions
@@ -53,8 +56,8 @@ runZendeskMain = do
     -- At this point, the configuration is set up and there is no point in using a pure IO.
     case args of
         CollectEmails            -> runApp collectEmails cfg
-        (ProcessTicket ticketId) -> runApp (processTicket ticketId) cfg
-        ProcessTickets           -> runApp processTickets cfg
+        (ProcessTicket ticketId) -> void $ runApp (processTicket ticketId) cfg
+        ProcessTickets           -> void $ runApp processTickets cfg
         FetchTickets             -> runApp fetchTickets cfg
         ShowStatistics           -> runApp showStatistics cfg
 
@@ -70,65 +73,80 @@ collectEmails = do
     let ticketIds = foldr (\TicketInfo{..} acc -> ticketId : acc) [] tickets
     mapM_ extractEmailAddress ticketIds
 
-processTicket :: TicketId -> App ()
+
+processTicket :: TicketId -> App [ZendeskResponse]
 processTicket ticketId = do
+
     -- We first fetch the function from the configuration
-    getTicketInfo <- asksZendeskLayer zlGetTicketInfo
-    putTextLn "Processing single ticket"
-    ticketInfo <- getTicketInfo ticketId
-    processTicketAndId ticketInfo
-    putTextLn "Process finished, please see the following url"
-    putTextLn $ "https://iohk.zendesk.com/agent/tickets/" <> show ticketId
+    getTicketInfo       <- asksZendeskLayer zlGetTicketInfo
+    printText           <- asksIOLayer iolPrintText
+
+    printText "Processing single ticket"
+
+    ticketInfo          <- getTicketInfo ticketId
+    attachments         <- getTicketAttachments ticketInfo
+
+    zendeskResponse     <- mapM (inspectAttachment ticketInfo) attachments
+
+    postTicketComment   <- asksZendeskLayer zlPostTicketComment
+    _                   <- mapM postTicketComment zendeskResponse
+
+    printText "Process finished, please see the following url"
+    printText $ "https://iohk.zendesk.com/agent/tickets/" <> show ticketId
+
+    pure zendeskResponse
+
 
 processTickets :: App ()
 processTickets = do
-    cfg <- ask
-    sortedTicketIds <- processBatchTickets cfg
-    mapM_ processTicketAndId sortedTicketIds
+    sortedTicketIds     <- listAndSortTickets
+
+    _                   <- mapM (processTicket . ticketId) sortedTicketIds
+
     putTextLn "All the tickets has been processed."
 
+
 fetchTickets :: App ()
 fetchTickets = do
-    cfg <- ask
-    sortedTicketIds <- processBatchTickets cfg
+    sortedTicketIds <- listAndSortTickets
     mapM_ (putTextLn . show) sortedTicketIds
     putTextLn "All the tickets has been processed."
 
+
 showStatistics :: App ()
 showStatistics = do
     cfg <- ask
     -- We first fetch the function from the configuration
     listTickets <- asksZendeskLayer zlListTickets
 
     putTextLn $ "Classifier is going to gather ticket information assigned to: " <> cfgEmail cfg
-    liftIO printWarning
-    tickets <- listTickets Assigned
+
+    tickets     <- listTickets Assigned
     liftIO $ printTicketCountMessage tickets (cfgEmail cfg)
 
 
-processBatchTickets :: Config -> App [TicketInfo]
-processBatchTickets cfg = do
+listAndSortTickets :: App [TicketInfo]
+listAndSortTickets = do
+
+    Config{..}  <- ask
 
     -- We first fetch the function from the configuration
     listTickets <- asksZendeskLayer zlListTickets
+    printText   <- asksIOLayer iolPrintText
+
+    printText $ "Classifier is going to process tickets assign to: " <> cfgEmail
 
-    putTextLn $  "Classifier is going to process tickets assign to: " <> cfgEmail cfg
-    liftIO printWarning
-    tickets <- listTickets Assigned
+    tickets     <- listTickets Assigned
 
     let filteredTicketIds = filterAnalyzedTickets tickets
     let sortedTicketIds   = sortBy compare filteredTicketIds
 
-    putTextLn $ "There are " <> show (length sortedTicketIds) <> " unanalyzed tickets."
-    putTextLn "Processing tickets, this may take hours to finish."
+    printText $ "There are " <> show (length sortedTicketIds) <> " unanalyzed tickets."
+    printText "Processing tickets, this may take hours to finish."
 
     pure sortedTicketIds
 
 
--- | Warning
-printWarning :: IO ()
-printWarning = putTextLn "Note that this process may take a while. Please do not kill the process"
-
 -- | Print how many tickets are assinged, analyzed, and unanalyzed
 printTicketCountMessage :: [TicketInfo] -> Text -> IO ()
 printTicketCountMessage tickets email = do
@@ -177,36 +195,42 @@ extractEmailAddress ticketId = do
     liftIO $ appendFile "emailAddress.txt" (emailAddress <> "\n")
     liftIO $ putTextLn emailAddress
 
+
 -- | Process specifig ticket id (can be used for testing) only inspects the one's with logs
-processTicketAndId :: TicketInfo -> App ()
-processTicketAndId ticketInfo@TicketInfo{..} = do
+-- TODO(ks): Switch to `(MonadReader Config m)`, pure function?
+getTicketAttachments :: TicketInfo -> App [Attachment]
+getTicketAttachments TicketInfo{..} = do
 
-    getTicketComments <- asksZendeskLayer zlGetTicketComments
+    -- Get the function from the configuration
+    getTicketComments   <- asksZendeskLayer zlGetTicketComments
+    comments            <- getTicketComments ticketId
+
+    -- However, if we want this to be more composable...
+    pure $ getAttachmentsFromComment comments
 
-    comments <- getTicketComments ticketId
 
+-- | A pure function for fetching @Attachment@ from @Comment@.
+getAttachmentsFromComment :: [Comment] -> [Attachment]
+getAttachmentsFromComment comments = do
     -- Filter tickets without logs
-    -- Could analyze the comments but I don't see it useful..
     let commentsWithAttachments :: [Comment]
-        commentsWithAttachments = filter (\x -> length (cAttachments x) > 0) comments
+        commentsWithAttachments = filter commentHasAttachment comments
 
     -- Filter out ticket without logs
     let attachments :: [Attachment]
         attachments = concatMap cAttachments commentsWithAttachments
 
-    let justLogs :: [Attachment]
-        justLogs = filter (\x -> "application/zip" == aContentType x) attachments
+    -- Filter out non-logs
+    filter isAttachmentZip attachments
 
-    mapM_ (inspectAttachmentAndPostComment ticketInfo) justLogs
+  where
+    commentHasAttachment :: Comment -> Bool
+    commentHasAttachment comment = length (cAttachments comment) > 0
 
--- | Inspect attachment then post comment to the ticket
-inspectAttachmentAndPostComment :: TicketInfo -> Attachment -> App ()
-inspectAttachmentAndPostComment ticketInfo attachment = do
-    liftIO $ putTextLn $ "Analyzing ticket: " <> show ticketInfo
-    zendeskResponse <- inspectAttachment ticketInfo attachment
+    -- Readability
+    isAttachmentZip :: Attachment -> Bool
+    isAttachmentZip attachment = "application/zip" == aContentType attachment
 
-    postTicketComment <- asksZendeskLayer zlPostTicketComment
-    postTicketComment zendeskResponse
 
 -- | Given number of file of inspect, knowledgebase and attachment,
 -- analyze the logs and return the results.
@@ -217,17 +241,18 @@ inspectAttachmentAndPostComment ticketInfo attachment = do
 inspectAttachment :: TicketInfo -> Attachment -> App ZendeskResponse
 inspectAttachment ticketInfo@TicketInfo{..} att = do
 
-    Config{..} <- ask
+    Config{..}      <- ask
 
-    getAttachment <- asksZendeskLayer zlGetAttachment
+    getAttachment   <- asksZendeskLayer zlGetAttachment
+    printText       <- asksIOLayer iolPrintText
 
     rawlog <- getAttachment att -- Get attachment
     let results = extractLogsFromZip cfgNumOfLogsToAnalyze rawlog
 
     case results of
         Left _ -> do
 
-            liftIO . putStrLn . renderErrorCode $ SentLogCorrupted
+            printText . renderErrorCode $ SentLogCorrupted
 
             pure ZendeskResponse
                 { zrTicketId    = ticketId
@@ -246,7 +271,7 @@ inspectAttachment ticketInfo@TicketInfo{..} att = do
 
                     let fErrorCode = foldr (\errorCode acc -> errorCode <> ";" <> acc) "" errorCodes
 
-                    liftIO . putTextLn $ fErrorCode
+                    printText fErrorCode
 
                     pure ZendeskResponse
                         { zrTicketId    = ticketId
@@ -257,7 +282,7 @@ inspectAttachment ticketInfo@TicketInfo{..} att = do
 
                 Left _ -> do
 
-                    liftIO . putStrLn . renderTicketStatus $ NoKnownIssue
+                    printText . renderTicketStatus $ NoKnownIssue
 
                     pure ZendeskResponse
                         { zrTicketId    = ticketId

src/Zendesk/Functions.hs

@@ -3,6 +3,8 @@
 
 module Zendesk.Functions
     ( basicZendeskLayer
+    , emptyZendeskLayer
+    , basicIOLayer
     , defaultConfig
     ) where
 
@@ -16,10 +18,11 @@ import           Network.HTTP.Simple (Request, addRequestHeader, getResponseBody
                                       parseRequest_, setRequestBasicAuth, setRequestBodyJSON,
                                       setRequestMethod, setRequestPath)
 
-import           Zendesk.Types (Attachment (..), Comment (..), Config (..), RequestType (..),
-                                Ticket (..), TicketId, TicketInfo (..), TicketList (..),
-                                TicketTag (..), ZendeskLayer (..), ZendeskResponse (..),
-                                parseAgentId, parseComments, parseTickets, renderTicketStatus)
+import           Zendesk.Types (Attachment (..), Comment (..), Config (..), IOLayer (..),
+                                RequestType (..), Ticket (..), TicketId, TicketInfo (..),
+                                TicketList (..), TicketTag (..), ZendeskLayer (..),
+                                ZendeskResponse (..), parseAgentId, parseComments, parseTickets,
+                                renderTicketStatus)
 
 
 -- | The default configuration.
@@ -35,6 +38,7 @@ defaultConfig =
         , cfgNumOfLogsToAnalyze = 5
         , cfgIsCommentPublic    = True -- TODO(ks): For now, we need this in CLI.
         , cfgZendeskLayer       = basicZendeskLayer
+        , cfgIOLayer            = basicIOLayer
         }
 
 -- | The basic Zendesk layer.
@@ -48,6 +52,24 @@ basicZendeskLayer = ZendeskLayer
     , zlGetTicketComments       = getTicketComments
     }
 
+basicIOLayer :: (MonadIO m, MonadReader Config m) => IOLayer m
+basicIOLayer = IOLayer
+    { iolPrintText              = putTextLn
+    , iolReadFile               = \_ -> error "Not implemented readFile!"
+    -- ^ TODO(ks): We need to implement this!
+    }
+
+-- | The non-implemented Zendesk layer.
+emptyZendeskLayer :: (MonadIO m, MonadReader Config m) => ZendeskLayer m
+emptyZendeskLayer = ZendeskLayer
+    { zlGetTicketInfo           = \_     -> error "Not implemented zlGetTicketInfo!"
+    , zlListTickets             = \_     -> error "Not implemented zlListTickets!"
+    , zlPostTicketComment       = \_     -> error "Not implemented zlPostTicketComment!"
+    , zlGetAgentId              = pure 1
+    , zlGetAttachment           = \_     -> error "Not implemented zlGetAttachment!"
+    , zlGetTicketComments       = \_     -> error "Not implemented zlGetTicketComments!"
+    }
+
 
 -- | Get single ticket info.
 getTicketInfo