Fixing CI pipeline, generating image for artifact testing, and generalizing ENVs in tests

Author: pebeto

.github/workflows/CI.yml

@@ -22,23 +22,27 @@ jobs:
           - x64
     steps:
       - uses: actions/checkout@v2
-      - name: Start services
-        run: docker-compose -f docker compose.test.yaml up -d
-#      - name: Setup custom python requirements
-#        if: hashFiles('**/requirements.txt', '**/pyproject.toml') == ''
-#        run: |
-#          touch ./requirements.txt
-#          echo "mlflow[auth]==3.2.0" > ./requirements.txt
-#      - uses: actions/setup-python@v4
-#        with:
-#          python-version: '3.12.3'
-#          cache: 'pip'
-#      - name: Setup mlflow locally
-#        run: |
-#          export MLFLOW_FLASK_SERVER_SECRET_KEY='mlflowclient.jl'
-#          pip install -r ./requirements.txt
-#          python3 /opt/hostedtoolcache/Python/3.12.3/x64/bin/mlflow server --app-name basic-auth --host 0.0.0.0 --port 5000 &
-#          sleep 5
+      - name: Setup custom python requirements
+        if: hashFiles('**/requirements.txt', '**/pyproject.toml') == ''
+        run: |
+          touch ./requirements.txt
+          echo "mlflow[auth]==3.6.0" > ./requirements.txt
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.12.3'
+          cache: 'pip'
+      - uses: infleet/[email protected]
+        with:
+          port: "9000"
+          version: "latest"
+          username: "minioadmin"
+          password: "minioadmin"
+      - name: Setup mlflow locally
+        run: |
+          export MLFLOW_FLASK_SERVER_SECRET_KEY='mlflowclient.jl'
+          pip install -r ./requirements.txt
+          python3 /opt/hostedtoolcache/Python/3.12.3/x64/bin/mlflow server --app-name basic-auth --host 0.0.0.0 --port 5000 &
+          sleep 5
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}
@@ -57,10 +61,6 @@ jobs:
       - uses: julia-actions/julia-runtest@v1
         env:
           JULIA_NUM_THREADS: '1'
-          MLFLOW_TRACKING_URI: "http://localhost:5050/api"
-          MLFLOW_S3_ENDPOINT_URL: "http://minio:9000"
-          AWS_ACCESS_KEY_ID: minioadmin
-          AWS_SECRET_ACCESS_KEY: minioadmin
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v3
         with:

Project.toml

@@ -1,7 +1,7 @@
 name = "MLFlowClient"
 uuid = "64a0f543-368b-4a9a-827a-e71edb2a0b83"
-authors = ["@deyandyankov, @pebeto, and contributors"]
 version = "0.7.0"
+authors = ["@deyandyankov, @pebeto, and contributors"]
 
 [deps]
 AWSS3 = "1c724243-ef5b-51ab-93f4-b0a88ac62a95"
@@ -22,13 +22,15 @@ FileTypes = "0.1.1"
 HTTP = "1.0"
 JSON = "0.21"
 Minio = "0.2.2"
+Plots = "1.41.2"
 ShowCases = "0.1"
 URIs = "1.0"
 julia = "1.0"
 
 [extras]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 
 [targets]
-test = ["Base64", "Test"]
+test = ["Base64", "Plots", "Test"]

test/assets/julia.png

@@ -1,6 +1,7 @@
 using Test
 using Dates
 using HTTP
+using Plots
 using UUIDs
 using Base64
 using MLFlowClient
@@ -18,8 +19,8 @@ using URIs
 Check MLFlow health endpoint. Return true if healthy, false otherwise.
 """
 function mlflow_server_is_running()
-    resp = HTTP.request("HEAD", "$(TEST_MLFLOW_URI)/health", readtimeout=10)
-    return resp.status == 200 
+    resp = HTTP.request("HEAD", "http://127.0.0.1:5050/health", readtimeout=10)
+    return resp.status == 200
 end
 
 # creates an instance of mlf
@@ -40,7 +41,11 @@ end
 Check minio health endpoint. Return true if health, false otherwise
 """
 function minio_is_running()
-    response = HTTP.request("HEAD", "$(TEST_MLFLOW_S3_ENDPOINT_URL)/minio/health/live", readtimeout=10)
+    response = HTTP.request(
+        "HEAD",
+        "http://127.0.0.1:9000/minio/health/live",
+        readtimeout=10,
+    )
     return response.status == 200
 end
 

test/base.jl

@@ -1,32 +1,15 @@
-if ~haskey(ENV, "MLFLOW_TRACKING_URI")
-    error("""WARNING: MLFLOW_TRACKING_URI is not set. 
-To run the unit tests, you need to set the URI of your MLFlow server API.
-
-A test environment is provided in .devcontainers/compose.yaml, start it as
-`docker-compose .devcontainers/compose.yaml up`.
-
-Then set the environment variables
-MLFLOW_TRACKING_URI="http://localhost:5050/api"
-AWS_ACCESS_KEY_ID="minioadmin"
-AWS_SECRET_ACCESS_KEY="minioadmin"
-MLFLOW_S3_ENDPOINT_URL="http://localhost:9000"
-""")
-end
-
-
-# Set up access to testing environment defined in docker-compose.test.yaml
-const TEST_MLFLOW_URI = "http://localhost:5050/"
-const TEST_MLFLOW_TRACKING_URI = "http://127.0.0.1:5050/api"
-const TEST_MLFLOW_S3_ENDPOINT_URL = get(ENV, "MLFLOW_S3_ENDPOINT_URL", "http://127.0.0.1:9000")
-const TEST_AWS_ACCESS_KEY_ID = get(ENV, "AWS_ACCESS_KEY_ID", "minioadmin")
-const TEST_AWS_SECRET_ACCESS_KEY = get(ENV, "AWS_SECRET_ACCESS_KEY", "minioadmin")
-
-
+@warn "To run this test suite, ensure to run `docker-compose -f docker-compose.test.yml up`"
 
+ENV["GKSwstype"]="nul" # to disable plotting windows during tests
+ENV["MLFLOW_TRACKING_URI"] = "http://127.0.0.1:5050/api"
 
 include("base.jl")
 
-const minio_cfg = MinioConfig(TEST_MLFLOW_S3_ENDPOINT_URL; username=TEST_AWS_ACCESS_KEY_ID, password=TEST_AWS_SECRET_ACCESS_KEY)
+const minio_cfg = MinioConfig(
+    "http://127.0.0.1:9000";
+    username="minioadmin",
+    password="minioadmin",
+)
 include("setup.jl")
 
 include("types/mlflow.jl")

test/runtests.jl

@@ -348,7 +348,8 @@ end
             write(fp, dummy_content)
         end
 
-        image_file_path = joinpath("test", "assets", "julia.png")
+        image_file_path = "fig.png"
+        savefig(plot(rand(10), rand(10)), image_file_path)
 
         @testset "upload new artifact" begin
             experiment_id = createexperiment(mlf, "test-experiment-logartifact")
@@ -396,10 +397,10 @@ end
             experiment_id = createexperiment(mlf, "test-experiment-logartifact-3")
             run = createrun(mlf, experiment_id)
 
-            @test logartifact(minio_cfg, run, image_file_path, "julia.png")
+            @test logartifact(minio_cfg, run, image_file_path, "fig.png")
             u = URI(run.info.artifact_uri)
             bucket_name = u.host
-            artifact_path = joinpath(u.path[2:end], "julia.png")
+            artifact_path = joinpath(u.path[2:end], "fig.png")
 
             # verify upload
             downloaded_content = s3_get(minio_cfg, bucket_name, artifact_path)
@@ -410,6 +411,7 @@ end
         end
 
         rm(dummy_file_path)
+        rm(image_file_path)
     end
 end
 

test/services/logger.jl

@@ -1,25 +1,22 @@
 # Test if MLFlow and Minio are running (see .devcontainers/compose.yaml)
 
 @testset verbose = true "infrastructure" begin
-    println("Testing if MLFlow is running")
-
     mlflow_up = try
         mlflow_server_is_running() 
     catch
         false 
     end
-    mlflow_up || @error "The MLFlow test instance is not running. Please start it as `docker-compose -f .devcontainers/compose.yaml -up"
+    mlflow_up || @error "The MLFlow test instance is not running."
 
     @test mlflow_up
-    println("Testing if Minio is running")
 
     minio_up = try
         minio_is_running()
     catch
         false
     end
 
-    minio_up || @error "The Minio test instance is not running. Please start the test environment as `docker-compose -f .devcontainers/compose.yaml up`"
+    minio_up || @error "The MiniO test instance is not running."
 
     @test minio_up 
 end