Improve unit tests (#14)

* refactor unit tests

Author: p-gw

.github/workflows/CI.yml

@@ -12,7 +12,7 @@ concurrency:
   cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 jobs:
   test:
-    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    name: Julia ${{ matrix.version }} - LimeSurvey ${{ matrix.lsversion }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -24,9 +24,11 @@ jobs:
           - ubuntu-latest
         arch:
           - x64
+        lsversion:
+          - 'latest'
     steps:
       - uses: actions/checkout@v2
-      - run: docker-compose -f test/docker-compose.yml up -d --build
+      - run: docker compose -f test/docker-compose.yml -f test/docker-compose.${{ matrix.lsversion }}.yml up -d --build
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}

src/CitrusAPI.jl

@@ -28,7 +28,7 @@ function connect!(client::CitrusClient, username::String, password::String; plug
     response = get_session_key(client, username, password, plugin=plugin)
     client.session_key = response
     @info "Connected to server '$(client.url)'\n\tSession key: $(client.session_key)"
-    return nothing
+    return response
 end
 
 """
@@ -39,10 +39,10 @@ Disconnect `client` from a LimeSurvey server by releasing the session key.
 See also: [`release_session_key`](@ref)
 """
 function disconnect!(client::CitrusClient)
-    release_session_key(client)
+    response = release_session_key(client)
     client.session_key = nothing
     @info "Disconnected from server '$(client.url)'"
-    return nothing
+    return response
 end
 
 # helpers

src/methods/activate_tokens.jl

@@ -7,7 +7,7 @@ Initialise the participants table for remote survey with `survey_id`.
 
 See also: <https://api.limesurvey.org/classes/remotecontrol_handle.html#method_activate_tokens>
 """
-function activate_tokens!(client::CitrusClient, survey_id::Int, attribute_fields::Vector{Int}=[])
+function activate_tokens!(client::CitrusClient, survey_id::Int, attribute_fields=Dict())
     payload = construct_payload("activate_tokens", [client.session_key, survey_id, attribute_fields])
     response = call_limesurvey_api(client, payload)
     return response

src/methods/export_responses_by_token.jl

@@ -12,3 +12,15 @@ function export_responses_by_token(client::CitrusClient, survey_id::Int, documen
     response = call_limesurvey_api(client, payload)
     return response
 end
+
+"""
+    export_responses_by_token(client, survey_id, token, sink; kwargs...)
+
+Export responses from remote survey with `survey_id` as a Tables.jl compatible `sink`, e.g. `DataFrame`.
+"""
+function export_responses_by_token(client::CitrusClient, survey_id::Int, token::AbstractString, sink=nothing; kwargs...)
+    isnothing(sink) && throw(ArgumentError("Provide a valid sink argument"))
+    response = export_responses_by_token(client, survey_id, "csv", token; kwargs...)
+    df = base64csv_to_sink(response, sink)
+    return df
+end

src/methods/list_participants.jl

@@ -1,10 +1,9 @@
 export list_participants
 
 """
-    list_participants(client, survey_id, start; kwargs...)
+    list_participants(client, survey_id, start=0; kwargs...)
 
 Return a list of participants for the remote survey with `survey_id`.
-A start ID (`start`) must be specified.
 
 ## Keyword arguments
 - `limit`: Number of participants to return (default: `10`)
@@ -14,7 +13,7 @@ A start ID (`start`) must be specified.
 
 See also: <https://api.limesurvey.org/classes/remotecontrol_handle.html#method_list_participants>
 """
-function list_participants(client::CitrusClient, survey_id::Int, start::Int; limit::Int=10, unused::Bool=false, attributes=false, conditions=[])
+function list_participants(client::CitrusClient, survey_id::Int, start::Int=0; limit::Int=10, unused::Bool=false, attributes=false, conditions=[])
     payload = construct_payload("list_participants", [client.session_key, survey_id, start, limit, unused, attributes, conditions])
     response = call_limesurvey_api(client, payload)
     return response

src/methods/release_session_key.jl

@@ -1,5 +1,4 @@
 export release_session_key
-export disconnect!
 
 """
     release_session_key(client)

test/Dockerfile

@@ -0,0 +1,3 @@
+ARG LS_VERSION
+FROM acspri/limesurvey:${LS_VERSION}
+COPY limesurvey/config.php /var/www/html/application/config/config.php

test/docker-compose.latest.yml

@@ -0,0 +1,5 @@
+services:
+  limesurvey:
+    build:
+      args:
+        LS_VERSION: latest

test/docker-compose.lts.yml

@@ -0,0 +1,5 @@
+services:
+  limesurvey:
+    build:
+      args:
+        LS_VERSION: lts

test/docker-compose.yml

@@ -1,12 +1,9 @@
 services:
   limesurvey:
-    image: acspri/limesurvey
+    build:
+      dockerfile: Dockerfile
     ports:
       - 8082:80
-    volumes:
-      - ./limesurvey/plugins:/var/www/html/plugins
-      - ./limesurvey/upload:/var/www/html/upload
-      - ./limesurvey/config:/var/www/html/application/config
     environment:
       LIMESURVEY_DB_PASSWORD: somepassword
       LIMESURVEY_ADMIN_USER: admin