assay-lua 0.17.6

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

--- @module assay.sonarqube
--- @description SonarQube code quality API. Quality gates, issues, hotspots, measures, projects.
--- @keywords sonarqube, sonar, quality-gate, issues, hotspots, measures, projects, code-quality, coverage, security, bugs, vulnerabilities
--- @quickref c.qualitygate:project_status(project_key) -> {projectStatus}|nil | Quality gate status for a project
--- @quickref c.issues:search(opts?) -> {total, issues} | Search issues
--- @quickref c.hotspots:search(opts?) -> {hotspots, paging} | Search security hotspots
--- @quickref c.measures:component(component, metric_keys) -> {component} | Component measures for metric keys
--- @quickref c.projects:search(opts?) -> {components, paging} | Search projects

local M = {}

local function encode(value)
  local out = tostring(value):gsub("([^A-Za-z0-9%-_.~])", function(ch)
    return string.format("%%%02X", string.byte(ch))
  end)
  return out
end

local function build_query(params)
  local parts = {}
  for k, v in pairs(params) do
    if v ~= nil then
      parts[#parts + 1] = k .. "=" .. encode(v)
    end
  end
  table.sort(parts)
  if #parts == 0 then return "" end
  return "?" .. table.concat(parts, "&")
end

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

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

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

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

  local c = {}

  -- ===== Quality Gates =====

  c.qualitygate = {}

  function c.qualitygate:project_status(project_key)
    return api_get("/api/qualitygates/project_status" .. build_query({ projectKey = project_key }))
  end

  -- ===== Issues =====

  c.issues = {}

  function c.issues:search(search_opts)
    search_opts = search_opts or {}
    return api_get("/api/issues/search" .. build_query({
      componentKeys = search_opts.component_keys,
      types = search_opts.types,
      severities = search_opts.severities,
      statuses = search_opts.statuses,
      resolved = search_opts.resolved,
      ps = search_opts.page_size,
      p = search_opts.page,
    }))
  end

  -- ===== Hotspots =====

  c.hotspots = {}

  function c.hotspots:search(search_opts)
    search_opts = search_opts or {}
    return api_get("/api/hotspots/search" .. build_query({
      projectKey = search_opts.project_key,
      status = search_opts.status,
      resolution = search_opts.resolution,
      ps = search_opts.page_size,
      p = search_opts.page,
    }))
  end

  -- ===== Measures =====

  c.measures = {}

  function c.measures:component(component, metric_keys)
    local keys = metric_keys
    if type(metric_keys) == "table" then keys = table.concat(metric_keys, ",") end
    return api_get("/api/measures/component" .. build_query({
      component = component,
      metricKeys = keys,
    }))
  end

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

  c.projects = {}

  function c.projects:search(search_opts)
    search_opts = search_opts or {}
    return api_get("/api/projects/search" .. build_query({
      q = search_opts.query,
      qualifiers = search_opts.qualifiers,
      ps = search_opts.page_size,
      p = search_opts.page,
    }))
  end

  return c
end

return M