setup integration test framework

Author: myrho

openapi/src/Api.elm

@@ -1,16 +1,16 @@
 module Api exposing
     ( Request
+    , map
     , request
     , send
     , sendWithCustomError
     , task
-    , map
     , withBasePath
-    , withTimeout
-    , withTracker
     , withBearerToken
     , withHeader
     , withHeaders
+    , withTimeout
+    , withTracker
     )
 
 import Http
@@ -20,8 +20,8 @@ import Task
 import Url.Builder
 
 
-type Request a =
-    Request
+type Request a
+    = Request
         { method : String
         , headers : List Http.Header
         , basePath : String
@@ -34,12 +34,12 @@ type Request a =
         }
 
 
-request : String -> String -> List ( String, String ) -> List (String, Maybe String) -> List (String, Maybe String) -> Maybe Json.Encode.Value -> Json.Decode.Decoder a -> Request a
+request : String -> String -> List ( String, String ) -> List ( String, Maybe String ) -> List ( String, Maybe String ) -> Maybe Json.Encode.Value -> Json.Decode.Decoder a -> Request a
 request method path pathParams queryParams headerParams body decoder =
     Request
         { method = method
         , headers = headers headerParams
-        , basePath = "https://api.graphsense.info"
+        , basePath = "http://localhost:9000"
         , pathParams = interpolatePath path pathParams
         , queryParams = queries queryParams
         , body = Maybe.withDefault Http.emptyBody (Maybe.map Http.jsonBody body)
@@ -93,6 +93,7 @@ map fn (Request req) =
         , tracker = req.tracker
         }
 
+
 withBasePath : String -> Request a -> Request a
 withBasePath basePath (Request req) =
     Request { req | basePath = basePath }
@@ -123,28 +124,29 @@ withHeaders headers_ (Request req) =
     Request { req | headers = req.headers ++ headers (List.map (Tuple.mapSecond Just) headers_) }
 
 
+
 -- HELPER
 
 
-headers : List (String, Maybe String) -> List Http.Header
+headers : List ( String, Maybe String ) -> List Http.Header
 headers =
-    List.filterMap (\(key, value) -> Maybe.map (Http.header key) value)
+    List.filterMap (\( key, value ) -> Maybe.map (Http.header key) value)
 
 
 interpolatePath : String -> List ( String, String ) -> List String
 interpolatePath rawPath pathParams =
     let
         interpolate =
-            (\(name, value) path -> String.replace ("{" ++ name ++ "}") value path)
+            \( name, value ) path -> String.replace ("{" ++ name ++ "}") value path
     in
     List.foldl interpolate rawPath pathParams
         |> String.split "/"
         |> List.drop 1
 
 
-queries : List (String, Maybe String) -> List Url.Builder.QueryParameter
+queries : List ( String, Maybe String ) -> List Url.Builder.QueryParameter
 queries =
-    List.filterMap (\(key, value) -> Maybe.map (Url.Builder.string key) value)
+    List.filterMap (\( key, value ) -> Maybe.map (Url.Builder.string key) value)
 
 
 expectJson : (Http.Error -> e) -> (Result e a -> msg) -> Json.Decode.Decoder a -> Http.Expect msg

src/Effect.elm

@@ -1,28 +1,35 @@
 module Effect exposing (Effect(..), n, perform)
 
+import Api
+import Api.Request.General
 import Browser.Navigation as Nav
-import Msg exposing (Msg)
+import Msg exposing (Msg(..))
 
 
 type Effect
     = NoEffect
     | NavLoadEffect String
-    | NavPushUrlEffect Nav.Key String
+    | NavPushUrlEffect String
+    | GetStatisticsEffect
 
 
 n : model -> ( model, Effect )
 n model =
     ( model, NoEffect )
 
 
-perform : Effect -> Cmd Msg
-perform effect =
+perform : Nav.Key -> Effect -> Cmd Msg
+perform key effect =
     case effect of
         NoEffect ->
             Cmd.none
 
         NavLoadEffect url ->
             Nav.load url
 
-        NavPushUrlEffect key url ->
+        NavPushUrlEffect url ->
             Nav.pushUrl key url
+
+        GetStatisticsEffect ->
+            Api.Request.General.getStatistics
+                |> Api.send BrowserGotStatistics

src/Init.elm

@@ -1,5 +1,6 @@
 module Init exposing (init)
 
+import Api.Data
 import Browser.Navigation as Nav
 import Effect exposing (Effect(..), n)
 import Iknaio
@@ -8,13 +9,15 @@ import Model exposing (..)
 import Url exposing (Url)
 
 
-init : Flags -> Url -> Nav.Key -> ( Model, Effect )
+init : Flags -> Url -> key -> ( Model key, Effect )
 init _ url key =
-    n
-        { url = url
-        , key = key
-        , locale = Locale.init
-        , theme = Iknaio.theme
-        , search = ()
-        , user = ()
-        }
+    ( { url = url
+      , key = key
+      , locale = Locale.init
+      , theme = Iknaio.theme
+      , search = ()
+      , user = ()
+      , stats = Api.Data.Stats Nothing Nothing Nothing
+      }
+    , GetStatisticsEffect
+    )

src/Main.elm

@@ -1,6 +1,7 @@
 module Main exposing (main)
 
 import Browser
+import Browser.Navigation as Nav
 import Effect exposing (perform)
 import Init exposing (init)
 import Model exposing (Flags, Model)
@@ -11,17 +12,21 @@ import Update exposing (update)
 import View exposing (view)
 
 
-main : Program Flags Model Msg
+main : Program Flags (Model Nav.Key) Msg
 main =
+    let
+        performEffect ( model, effect ) =
+            ( model, perform model.key effect )
+    in
     Browser.application
         { init =
             \flags url key ->
                 init flags url key
-                    |> Tuple.mapSecond perform
+                    |> performEffect
         , update =
             \msg model ->
                 update msg model
-                    |> Tuple.mapSecond perform
+                    |> performEffect
         , view = view
         , subscriptions = subscriptions
         , onUrlChange = BrowserChangedUrl

src/Model.elm

@@ -1,5 +1,6 @@
 module Model exposing (..)
 
+import Api.Data
 import Browser.Navigation as Nav
 import Locale.Model as Locale
 import Themes.Model exposing (Theme)
@@ -15,11 +16,12 @@ type alias Config =
     }
 
 
-type alias Model =
+type alias Model navigationKey =
     { url : Url
-    , key : Nav.Key
+    , key : navigationKey
     , locale : Locale.Model
     , theme : Theme
     , search : ()
     , user : ()
+    , stats : Api.Data.Stats
     }

src/Msg.elm

@@ -1,10 +1,13 @@
 module Msg exposing (Msg(..))
 
+import Api.Data
 import Browser exposing (UrlRequest)
+import Http
 import Model exposing (..)
 import Url exposing (Url)
 
 
 type Msg
     = UserRequestsUrl UrlRequest
     | BrowserChangedUrl Url
+    | BrowserGotStatistics (Result Http.Error Api.Data.Stats)

src/Sub.elm

@@ -1,9 +1,10 @@
 module Sub exposing (subscriptions)
 
+import Browser.Navigation as Nav
 import Model exposing (Model)
 import Msg exposing (Msg)
 
 
-subscriptions : Model -> Sub Msg
+subscriptions : Model Nav.Key -> Sub Msg
 subscriptions _ =
     Sub.none

src/Update.elm

@@ -1,21 +1,22 @@
 module Update exposing (update)
 
 import Browser
+import Browser.Navigation as Nav
 import Effect exposing (Effect(..), n)
 import Model exposing (Model)
 import Msg exposing (..)
 import Url exposing (Url)
 
 
-update : Msg -> Model -> ( Model, Effect )
+update : Msg -> Model key -> ( Model key, Effect )
 update msg model =
     case msg of
         UserRequestsUrl request ->
             case request of
                 Browser.Internal url ->
                     ( model
                     , Url.toString url
-                        |> NavPushUrlEffect model.key
+                        |> NavPushUrlEffect
                     )
 
                 Browser.External url ->
@@ -26,7 +27,15 @@ update msg model =
         BrowserChangedUrl url ->
             updateByUrl url model
 
+        BrowserGotStatistics result ->
+            case result of
+                Ok stats ->
+                    n { model | stats = stats }
 
-updateByUrl : Url -> Model -> ( Model, Effect )
+                Err _ ->
+                    n model
+
+
+updateByUrl : Url -> Model key -> ( Model key, Effect )
 updateByUrl _ model =
     n model

src/View.elm

@@ -10,7 +10,7 @@ import Msg exposing (..)
 import View.Header as Header
 
 
-view : Model -> Document Msg
+view : Model key -> Document Msg
 view model =
     { title = model.locale.getString "Iknaio Dashboard"
     , body =
@@ -20,7 +20,7 @@ view model =
     }
 
 
-body : Model -> Html Msg
+body : Model key -> Html Msg
 body model =
     div
         [ css
@@ -62,7 +62,7 @@ body model =
                     [ flexGrow (num 1)
                     ]
                 ]
-                [ text "MAIN"
+                [ text <| Maybe.withDefault "no_version" <| model.stats.version
                 ]
             ]
         ]

tests/Stats.elm

@@ -1,32 +1,67 @@
 module Stats exposing (exampleProgramTest, start)
 
+import Api.Data
+import Effect exposing (Effect(..))
+import Expect
+import Init exposing (init)
+import Json.Decode as Dec
+import Json.Encode as Enc
+import Model exposing (Flags, Model)
+import Msg exposing (Msg(..))
 import ProgramTest exposing (ProgramTest, clickButton, expectViewHas)
+import SimulatedEffect.Cmd
+import SimulatedEffect.Http
 import Test exposing (..)
 import Test.Html.Selector exposing (class, text)
 import Update exposing (update)
+import View exposing (view)
 
 
-start : String -> Flags -> ProgramTest Model Msg (Cmd Msg)
+start : String -> Flags -> ProgramTest (Model ()) Msg Effect
 start initialUrl flags =
     ProgramTest.createApplication
-        { onUrlChange = MyProgram.OnRouteChange
-        , init =
-            -- NOTE: the type of MyProgram.init is:
-            -- MyProgram.Flags -> Navigation.Location -> (MyProgram.Model, Cmd MyProgram.Msg)
-            MyProgram.init
-        , update = MyProgram.update
-        , view = MyProgram.view
+        { onUrlChange = BrowserChangedUrl
+        , onUrlRequest = UserRequestsUrl
+        , init = init
+        , update = update
+        , view = view
         }
         |> ProgramTest.withBaseUrl initialUrl
+        |> ProgramTest.withSimulatedEffects simulateEffects
         |> ProgramTest.start flags
 
 
 exampleProgramTest : Test
 exampleProgramTest =
-    test "pages show social media link at the end" <|
+    test "fetch stats on start up" <|
         \() ->
-            start "https://app" MyProgram.defaultFlags
+            start "https://app" {}
+                |> ProgramTest.simulateHttpOk
+                    "GET"
+                    "http://localhost:9000/stats"
+                    (Api.Data.encodeStats (Api.Data.Stats Nothing Nothing <| Just "the_version")
+                        |> Enc.encode 0
+                    )
                 |> expectViewHas
-                    [ class "super-social-link"
-                    , attribute (href "https://super.social.example.com/avh4")
+                    [ text "the_version"
                     ]
+
+
+simulateEffects : Effect -> ProgramTest.SimulatedEffect Msg
+simulateEffects effect =
+    case effect of
+        NoEffect ->
+            SimulatedEffect.Cmd.none
+
+        NavLoadEffect _ ->
+            SimulatedEffect.Cmd.none
+
+        NavPushUrlEffect _ ->
+            SimulatedEffect.Cmd.none
+
+        GetStatisticsEffect ->
+            SimulatedEffect.Http.get
+                { url = "http://localhost:9000/stats"
+                , expect =
+                    SimulatedEffect.Http.expectJson BrowserGotStatistics Api.Data.statsDecoder
+                }