assay-lua 0.10.2

General-purpose enhanced Lua runtime. Batteries-included scripting, automation, and web services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221

--- @module assay.harbor
--- @description Harbor container registry. Projects, repositories, artifacts, vulnerability scanning.
--- @keywords harbor, registry, artifacts, vulnerabilities, scanning, containers, project, repository, artifact, tag, scan, vulnerability, replication, image, docker, container-registry, oci
--- @quickref c.system:health() -> {status, components} | Check Harbor health
--- @quickref c.system:info() -> {harbor_version, ...} | Get system information
--- @quickref c.system:statistics() -> {private_project_count, ...} | Get registry statistics
--- @quickref c.system:is_healthy() -> bool | Check if all components are healthy
--- @quickref c.projects:list(opts?) -> [project] | List projects
--- @quickref c.projects:get(name_or_id) -> project | Get project by name or ID
--- @quickref c.repositories:list(project_name, opts?) -> [repo] | List repositories in project
--- @quickref c.repositories:get(project_name, repo_name) -> repo | Get repository
--- @quickref c.artifacts:list(project_name, repo_name, opts?) -> [artifact] | List artifacts
--- @quickref c.artifacts:get(project_name, repo_name, reference) -> artifact | Get artifact by reference
--- @quickref c.artifacts:tags(project_name, repo_name, reference) -> [tag] | List artifact tags
--- @quickref c.artifacts:exists(project_name, repo_name, tag) -> bool | Check if image tag exists
--- @quickref c.artifacts:latest(project_name, repo_name) -> artifact|nil | Get latest artifact
--- @quickref c.scan:trigger(project_name, repo_name, reference) -> true | Trigger vulnerability scan
--- @quickref c.scan:vulnerabilities(project, repo, ref) -> {total, critical, ...}|nil | Get vulnerabilities
--- @quickref c.replication:policies() -> [policy] | List replication policies
--- @quickref c.replication:executions(opts?) -> [execution] | List replication executions

local M = {}

function M.client(url, opts)
  opts = opts or {}
  local base_url = url:gsub("/+$", "")
  local api_key = opts.api_key
  local username = opts.username
  local password = opts.password

  -- Shared HTTP helpers (plain closures capturing upvalues)

  local function headers()
    local h = { ["Content-Type"] = "application/json" }
    if api_key then
      h["Authorization"] = "Bearer " .. api_key
    elseif username and password then
      h["Authorization"] = "Basic " .. base64.encode(username .. ":" .. password)
    end
    return h
  end

  local function api_get(path_str)
    local resp = http.get(base_url .. path_str, { headers = headers() })
    if resp.status ~= 200 then
      error("harbor: GET " .. path_str .. " HTTP " .. resp.status .. ": " .. resp.body)
    end
    return json.parse(resp.body)
  end

  local function api_post(path_str, payload)
    local resp = http.post(base_url .. path_str, payload, { headers = headers() })
    return resp
  end

  local function build_qs(params)
    if #params == 0 then return "" end
    return "?" .. table.concat(params, "&")
  end

  -- ===== Client =====

  local c = {}

  -- ===== System =====

  c.system = {}

  function c.system:health()
    return api_get("/api/v2.0/health")
  end

  function c.system:info()
    return api_get("/api/v2.0/systeminfo")
  end

  function c.system:statistics()
    return api_get("/api/v2.0/statistics")
  end

  function c.system:is_healthy()
    local h = c.system:health()
    if not h.components then return false end
    for i = 1, #h.components do
      if h.components[i].status ~= "healthy" then
        return false
      end
    end
    return true
  end

  -- ===== Projects =====

  c.projects = {}

  function c.projects:list(list_opts)
    list_opts = list_opts or {}
    local params = {}
    if list_opts.name then params[#params + 1] = "name=" .. list_opts.name end
    if list_opts.public ~= nil then params[#params + 1] = "public=" .. tostring(list_opts.public) end
    if list_opts.page then params[#params + 1] = "page=" .. list_opts.page end
    if list_opts.page_size then params[#params + 1] = "page_size=" .. list_opts.page_size end
    return api_get("/api/v2.0/projects" .. build_qs(params))
  end

  function c.projects:get(name_or_id)
    return api_get("/api/v2.0/projects/" .. name_or_id)
  end

  -- ===== Repositories =====

  c.repositories = {}

  function c.repositories:list(project_name, list_opts)
    list_opts = list_opts or {}
    local params = {}
    if list_opts.page then params[#params + 1] = "page=" .. list_opts.page end
    if list_opts.page_size then params[#params + 1] = "page_size=" .. list_opts.page_size end
    if list_opts.q then params[#params + 1] = "q=" .. list_opts.q end
    return api_get("/api/v2.0/projects/" .. project_name .. "/repositories" .. build_qs(params))
  end

  function c.repositories:get(project_name, repo_name)
    return api_get("/api/v2.0/projects/" .. project_name .. "/repositories/" .. repo_name)
  end

  -- ===== Artifacts =====

  c.artifacts = {}

  function c.artifacts:list(project_name, repo_name, list_opts)
    list_opts = list_opts or {}
    local params = {}
    if list_opts.page then params[#params + 1] = "page=" .. list_opts.page end
    if list_opts.page_size then params[#params + 1] = "page_size=" .. list_opts.page_size end
    if list_opts.with_tag ~= nil then params[#params + 1] = "with_tag=" .. tostring(list_opts.with_tag) end
    if list_opts.with_scan_overview ~= nil then params[#params + 1] = "with_scan_overview=" .. tostring(list_opts.with_scan_overview) end
    return api_get("/api/v2.0/projects/" .. project_name .. "/repositories/" .. repo_name .. "/artifacts" .. build_qs(params))
  end

  function c.artifacts:get(project_name, repo_name, reference)
    return api_get("/api/v2.0/projects/" .. project_name .. "/repositories/" .. repo_name .. "/artifacts/" .. reference)
  end

  function c.artifacts:tags(project_name, repo_name, reference)
    return api_get("/api/v2.0/projects/" .. project_name .. "/repositories/" .. repo_name .. "/artifacts/" .. reference .. "/tags")
  end

  function c.artifacts:exists(project_name, repo_name, tag)
    local resp = http.get(
      base_url .. "/api/v2.0/projects/" .. project_name .. "/repositories/" .. repo_name .. "/artifacts/" .. tag,
      { headers = headers() }
    )
    return resp.status == 200
  end

  function c.artifacts:latest(project_name, repo_name)
    local list = c.artifacts:list(project_name, repo_name, { page_size = 1 })
    if #list == 0 then return nil end
    return list[1]
  end

  -- ===== Scan =====

  c.scan = {}

  function c.scan:trigger(project_name, repo_name, reference)
    local resp = api_post("/api/v2.0/projects/" .. project_name .. "/repositories/" .. repo_name .. "/artifacts/" .. reference .. "/scan", {})
    if resp.status ~= 202 then
      error("harbor: POST scan HTTP " .. resp.status .. ": " .. resp.body)
    end
    return true
  end

  function c.scan:vulnerabilities(project_name, repo_name, reference)
    local resp = http.get(
      base_url .. "/api/v2.0/projects/" .. project_name .. "/repositories/" .. repo_name .. "/artifacts/" .. reference .. "?with_scan_overview=true",
      { headers = headers() }
    )
    if resp.status ~= 200 then
      error("harbor: GET artifact vulnerabilities HTTP " .. resp.status .. ": " .. resp.body)
    end
    local data = json.parse(resp.body)
    if not data.scan_overview then return nil end
    local report = nil
    for mime_type, val in pairs(data.scan_overview) do
      report = val
      break
    end
    if not report or not report.summary then return nil end
    local sum = report.summary
    return {
      total = sum.total or 0,
      fixable = sum.fixable or 0,
      critical = (sum.summary and sum.summary.Critical) or 0,
      high = (sum.summary and sum.summary.High) or 0,
      medium = (sum.summary and sum.summary.Medium) or 0,
      low = (sum.summary and sum.summary.Low) or 0,
      negligible = (sum.summary and sum.summary.Negligible) or 0,
    }
  end

  -- ===== Replication =====

  c.replication = {}

  function c.replication:policies()
    return api_get("/api/v2.0/replication/policies")
  end

  function c.replication:executions(exec_opts)
    exec_opts = exec_opts or {}
    local params = {}
    if exec_opts.policy_id then params[#params + 1] = "policy_id=" .. exec_opts.policy_id end
    return api_get("/api/v2.0/replication/executions" .. build_qs(params))
  end

  return c
end

return M