test/stats_cli.lua

#!/usr/bin/env lua

--[[
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
]]--

-- Allow CLI testing of stats.lua query parameters
-- Invoke with pairs of parameters, being the key and value, e.g.
-- lua test_stats.lua list dev domain ponymail.apache.org q 'a/b' d lte=1y emailsOnly 1
-- Note that parameters with no values are given the default value of "1" by mod_lua
-- set MODE=inspect to print output query from inspect, otherwise print as JSON suitable for further processing

-- Update path so we can always find the api/*.lua scripts
local self=arg[0] or './dummy' -- get path to self
local pfx=self:match("^.*/") or "" -- extract the path
-- finally update package path (also adding current dir)
package.path = package.path .. ";" .. pfx .. "../site/api/?.lua"   -- path to api dir
package.path = package.path .. ";" .. pfx .. "/?.lua" -- current dir

local inspect = require 'inspect'
local http = require 'socket.http'
local mock = require 'mock_r'
local JSON = require 'cjson'
require 'stats' -- local makes no difference here

local _CACHE = {} -- capture output

-- override http request so can capture the query
http.request = function(url, data)
  -- capture HTTP parameters (assume only called once)
  _CACHE.url = url
  _CACHE.querydata = JSON.decode(data)
  -- return simplest result that satisfies stats.lua
  result = [[
{
  "hits" : {
  "total" : 0,
  "hits" : [ ]
  }
}
]]
  return result, 200
end


local r = mock.r

-- disable years active check
r.ivm_get = function(r, key)
  return JSON.encode({ pubfirst = 0, publast = 0})
end

-- collect output (assume only one call to puts)
r.puts = function(r, ...) _CACHE.reply = JSON.decode(...) end

-- TODO
r.escape_html = function(r, val)
  -- < > & are definitely escaped by the real escape_html
  return val:gsub('>', '&gt;'):gsub('<', '&lt;'):gsub('&', '&amp;')
end

-- override the parse-args function so it returns our test data
r.parseargs = function(r)
  return _CACHE.args
end


local function test(args)
  local output = {
    quick = true, -- disable most queries
  }
  -- merge in user data
  for k,v in pairs(args) do output[k] = v end  
  _CACHE.args = output -- save the args
  _CACHE.status = handle(r)
  return _CACHE
end

local argc = #arg
if argc == 0 -- assume reading lines of JSON strings
then
  for line in io.lines()
  do
    jzon = JSON.decode(line)
    jzon.quick = true -- disable most queries
    _CACHE.args = jzon
    _CACHE.status = handle(r)
    print(JSON.encode(_CACHE)) 
    io.flush()     
  end
elseif argc % 2 == 0
then
  local data = {}
  for i = 1,argc,2 do
    data[arg[i]] = arg[i+1]
  end
  res = test(data)
  if os.getenv("MODE") == "inspect" then
    print(inspect(res["querydata"]))
  else
    print(JSON.encode(res))
  end
elseif argc == 1 -- assume JSON string
then
  jzon = JSON.decode(arg[1])
  jzon.quick = true -- disable most queries
  _CACHE.args = jzon
  _CACHE.status = handle(r)
  print(JSON.encode(_CACHE))
else
  print("Need even arg count")
  os.exit(1)
end