Merge pull request #47 from JuliaComputing/tan/misc

allow timeout to be set via KuberContext

Author: tanmaykm

README.md

@@ -4,7 +4,7 @@
 
 A Julia Kubernetes Client.
 
-An easy to use API to access Kubernetes clusters from Julia. The `Kuber.Kubernetes` submodule has the complete set of low level APIs and entities.
+An easy to use API to access Kubernetes clusters from Julia. The `Kuber.ApiImpl.Kubernetes` submodule has the complete set of low level APIs and entities.
 
 Most of the low level APIs fit into a common usage pattern. Kuber.jl makes it possible to use all of them with only a few intuitive verb based APIs. Verbs act on entities. Entities can be identified by names or selector patterns, or otherwise can apply to all entities of that class. Verbs can take additional parameters, e.g. when creating or updating entities.
 

WalkThrough.md

@@ -145,10 +145,10 @@ Now that we have set up our connection properly, let's explore what we have in o
 julia> result = get(ctx, :ComponentStatus);
 
 julia> typeof(result)
-Kuber.Kubernetes.IoK8sApiCoreV1ComponentStatusList
+Kuber.ApiImpl.Kubernetes.IoK8sApiCoreV1ComponentStatusList
 ```
 
-Note that we got back a Julia type `Kuber.Kubernetes.IoK8sApiCoreV1ComponentStatusList`. It represents a list of `ComponentStatus` entities that we asked for. It has been resolved to match the specific to the version of API we used - `CoreV1` in this case. We can display the entity in JSON form in the REPL, by simply `show`ing it.
+Note that we got back a Julia type `Kuber.ApiImpl.Kubernetes.IoK8sApiCoreV1ComponentStatusList`. It represents a list of `ComponentStatus` entities that we asked for. It has been resolved to match the specific to the version of API we used - `CoreV1` in this case. We can display the entity in JSON form in the REPL, by simply `show`ing it.
 
 ```julia
 julia> result
@@ -245,7 +245,7 @@ julia> nginx_pod = kuber_obj(ctx, """{
        }""");
 
 julia> typeof(nginx_pod)
-Kuber.Kubernetes.IoK8sApiCoreV1Pod
+Kuber.ApiImpl.Kubernetes.IoK8sApiCoreV1Pod
 
 julia> nginx_service = kuber_obj(ctx, """{
            "kind": "Service",
@@ -263,7 +263,7 @@ julia> nginx_service = kuber_obj(ctx, """{
        }""")
 
 julia> typeof(nginx_service)
-Kuber.Kubernetes.IoK8sApiCoreV1Service
+Kuber.ApiImpl.Kubernetes.IoK8sApiCoreV1Service
 ```
 
 To create the pod in the cluster, use the `put!` API. And we should see it when we list the pods.

src/helpers.jl

@@ -41,11 +41,11 @@ mutable struct KuberContext
     retry_all_apis::Bool
     initialized::Bool
 
-    function KuberContext(apimodule::Module=ApiImpl)
+    function KuberContext(apimodule::Module=ApiImpl; kwargs...)
         kctx = new(apimodule)
 
         rtfn = (default,data)->kuber_type(kctx, default, data)
-        swaggerclient = Swagger.Client(DEFAULT_URI; get_return_type=rtfn)
+        swaggerclient = Swagger.Client(DEFAULT_URI; get_return_type=rtfn, kwargs...)
         swaggerclient.headers["Connection"] = "close"
 
         kctx.client = swaggerclient
@@ -85,6 +85,26 @@ end
 retries(ctx::KuberContext, mutating::Bool=true) = (mutating && !ctx.retry_all_apis) ? 1 : ctx.default_retries
 retries(watch::KuberWatchContext, mutating::Bool=true) = retries(watch.ctx, mutating)
 
+get_client(ctx::KuberContext) = ctx.client
+get_client(ctx::KuberWatchContext) = ctx.ctx.client
+
+get_timeout(ctx::Union{KuberContext,KuberWatchContext}) = get_client(ctx).timeout[]
+
+function set_timeout(ctx::Union{KuberContext,KuberWatchContext}, timeout::Integer)
+    Swagger.set_timeout(get_client(ctx), timeout)
+    ctx
+end
+
+function with_timeout(fn, ctx::Union{KuberContext,KuberWatchContext}, timeout::Integer)
+    old_timeout = get_timeout(ctx)
+    set_timeout(ctx, timeout)
+    try
+        fn(ctx)
+    finally
+        set_timeout(ctx, old_timeout)
+    end
+end
+
 convert(::Type{Vector{UInt8}}, s::T) where {T<:AbstractString} = collect(codeunits(s))
 convert(::Type{T}, json::String) where {T<:SwaggerModel} = convert(T, JSON.parse(json))
 convert(::Type{Dict{String,Any}}, model::T) where {T<:SwaggerModel} = JSON.parse(JSON.json(model))

test/runtests.jl

@@ -1,4 +1,5 @@
 using Kuber
+using Swagger
 using Test
 
 const Typedefs = Kuber.ApiImpl.Typedefs
@@ -23,6 +24,23 @@ function init_context(override=nothing, verbose=true)
     ctx
 end
 
+function test_set_timeout(ctx)
+    @test Kuber.get_timeout(ctx) == Swagger.DEFAULT_TIMEOUT_SECS
+
+    Kuber.with_timeout(ctx, 10) do ctx
+        @test Kuber.get_timeout(ctx) == 10
+    end
+
+    wctx = Kuber.KuberWatchContext(ctx, Channel{Any}())
+    @test Kuber.get_timeout(wctx) == Swagger.DEFAULT_TIMEOUT_SECS
+    Kuber.with_timeout(wctx, 10) do wctx
+        @test Kuber.get_timeout(wctx) == 10
+    end
+    @test Kuber.get_timeout(wctx) == Swagger.DEFAULT_TIMEOUT_SECS
+
+    @test Kuber.get_timeout(ctx) == Swagger.DEFAULT_TIMEOUT_SECS
+end
+
 function list_cluster_components(ctx)
     @testset "List component status" begin
         res = get(ctx, :ComponentStatus)
@@ -299,6 +317,10 @@ function test_all()
             test_versioned(ctx, "1")
         end
 
+        @testset "Set Timeouts" begin
+            test_set_timeout(ctx)            
+        end
+
         @testset "Overridden API Versions" begin
             @test ctx.apis[:Apiregistration][1].api == Kubernetes.ApiregistrationV1Api
             @test ctx.apis[:Apps][1].api == Kubernetes.AppsV1Api