[qa] Format Lua Files #51

Closes #51

Author: devkapilbansal

.luacheckrc

@@ -1,3 +1,5 @@
 files["openwrt-openwisp-monitoring/tests"]={
 	ignore={"Test.*"}
 }
+
+max_line_length=88

README.rst

@@ -172,6 +172,14 @@ You can inspect the version of openwisp-monitoring currently installed with::
 
     openwisp_monitoring --version
 
+Quality Assurance Checks
+------------------------
+
+We use `LuaFormatter <https://luarocks.org/modules/tammela/luaformatter>`_ to format lua files.
+Once it is installed, you can format all files by::
+
+    ./qa-format
+
 Run tests
 ---------
 

install-dev.sh

@@ -15,6 +15,9 @@ git clone https://git.openwrt.org/project/uci.git --depth=1
 cd uci && cmake . && make install && cd .. || { echo 'Installing uci failed!' ; exit 1; }
 #install nixio
 luarocks install https://raw.githubusercontent.com/Neopallium/nixio/master/nixio-scm-0.rockspec
+# install luaformatter
+git clone --recurse-submodules https://github.com/Koihik/LuaFormatter.git
+cd LuaFormatter && cmake . && make install && cd .. || { echo 'Installing LuaFormatter failed'; exit 1; }
 # update links to shared libraries
 ldconfig -v
 # install luaunit
@@ -26,4 +29,4 @@ luarocks install lua-cjson
 #install luacov-coveralls
 luarocks install luacov-coveralls
 #clean
-rm -rf json-c libubox uci
+rm -rf json-c libubox uci LuaFormatter

openwrt-openwisp-monitoring/files/lib/openwisp/dhcp.lua

@@ -1,42 +1,39 @@
-package.path=package.path .. ";../files/lib/?.lua"
+package.path = package.path .. ";../files/lib/?.lua"
 
 -- retrieve dhcp leases
-local utils=require('openwisp.monitoring_utils')
-local uci=require('uci')
-local uci_cursor=uci.cursor()
-local io=require('io')
-local dhcp={}
+local utils = require('openwisp.monitoring_utils')
+local uci = require('uci')
+local uci_cursor = uci.cursor()
+local io = require('io')
+local dhcp = {}
 
 function dhcp.parse_dhcp_lease_file(path, leases)
-  local f=io.open(path, 'r')
-  if not f then
-    return leases
-  end
+  local f = io.open(path, 'r')
+  if not f then return leases end
   for line in f:lines() do
-    local expiry, mac, ip, name, id=line:match('(%S+)%s+(%S+)%s+(%S+)%s+(%S+)%s+(%S+)')
+    local expiry, mac, ip, name, id = line:match(
+      '(%S+)%s+(%S+)%s+(%S+)%s+(%S+)%s+(%S+)')
     table.insert(leases, {
-      expiry=tonumber(expiry),
-      mac=mac,
-      ip=ip,
-      client_name=name,
-      client_id=id
+      expiry = tonumber(expiry),
+      mac = mac,
+      ip = ip,
+      client_name = name,
+      client_id = id
     })
   end
 
   return leases
 end
 
 function dhcp.get_dhcp_leases()
-  local dhcp_configs=uci_cursor:get_all('dhcp')
-  local leases={}
+  local dhcp_configs = uci_cursor:get_all('dhcp')
+  local leases = {}
 
-  if utils.is_table_empty(dhcp_configs) then
-    return nil
-  end
+  if utils.is_table_empty(dhcp_configs) then return nil end
 
   for _, config in pairs(dhcp_configs) do
-    if config and config['.type']=='dnsmasq' and config.leasefile then
-      leases=dhcp.parse_dhcp_lease_file(config.leasefile, leases)
+    if config and config['.type'] == 'dnsmasq' and config.leasefile then
+      leases = dhcp.parse_dhcp_lease_file(config.leasefile, leases)
     end
   end
   return leases

openwrt-openwisp-monitoring/files/lib/openwisp/interfaces.lua

@@ -1,153 +1,149 @@
 -- retrieve interfaces information
-local utils=require('openwisp.monitoring_utils')
+local utils = require('openwisp.monitoring_utils')
 
-local cjson=require('cjson')
-local nixio=require('nixio')
-local nixio_data=nixio.getifaddrs()
-local io=require('io')
+local cjson = require('cjson')
+local nixio = require('nixio')
+local nixio_data = nixio.getifaddrs()
+local io = require('io')
 
-local uci=require('uci')
-local uci_cursor=uci.cursor()
+local uci = require('uci')
+local uci_cursor = uci.cursor()
 
-local ubus_lib=require('ubus')
-local ubus=ubus_lib.connect()
-if not ubus then
-  error('Failed to connect to ubusd')
-end
-local interface_data=ubus:call('network.interface', 'dump', {})
+local ubus_lib = require('ubus')
+local ubus = ubus_lib.connect()
+if not ubus then error('Failed to connect to ubusd') end
+local interface_data = ubus:call('network.interface', 'dump', {})
 
-local interfaces={}
+local interfaces = {}
 
-local specialized_interfaces={
-  modemmanager=function(_, interface)
-    local modem=uci_cursor.get('network', interface['interface'], 'device')
-    local info={}
-    local general_file=io.popen('mmcli --output-json -m '..modem)
-    local general=general_file:read("*a")
+local specialized_interfaces = {
+  modemmanager = function(_, interface)
+    local modem = uci_cursor.get('network', interface['interface'], 'device')
+    local info = {}
+    local general_file = io.popen('mmcli --output-json -m ' .. modem)
+    local general = general_file:read("*a")
     general_file:close()
     if general and pcall(cjson.decode, general) then
-      general=cjson.decode(general)
-      general=general.modem
+      general = cjson.decode(general)
+      general = general.modem
 
       if not utils.is_table_empty(general['3gpp']) then
-        info.imei=general['3gpp'].imei
-        info.operator_name=general['3gpp']['operator-name']
-        info.operator_code=general['3gpp']['operator-code']
+        info.imei = general['3gpp'].imei
+        info.operator_name = general['3gpp']['operator-name']
+        info.operator_code = general['3gpp']['operator-code']
       end
 
       if not utils.is_table_empty(general.generic) then
-        info.manufacturer=general.generic.manufacturer
-        info.model=general.generic.model
-        info.connection_status=general.generic.state
-        info.power_status=general.generic['power-state']
+        info.manufacturer = general.generic.manufacturer
+        info.model = general.generic.model
+        info.connection_status = general.generic.state
+        info.power_status = general.generic['power-state']
       end
     end
 
-    local signal_file=io.popen('mmcli --output-json -m '..modem..' --signal-get')
+    local signal_file =
+      io.popen('mmcli --output-json -m ' .. modem .. ' --signal-get')
     local signal = signal_file:read("*a")
     signal_file:close()
     if signal and pcall(cjson.decode, signal) then
-      signal=cjson.decode(signal)
+      signal = cjson.decode(signal)
       -- only send data if not empty to avoid generating too much traffic
-      if not utils.is_table_empty(signal.modem) and not utils.is_table_empty(signal.modem.signal) then
+      if not utils.is_table_empty(signal.modem) and
+        not utils.is_table_empty(signal.modem.signal) then
         -- omit refresh rate
-        signal.modem.signal.refresh=nil
-        info.signal={}
+        signal.modem.signal.refresh = nil
+        info.signal = {}
         -- collect section and values only if not empty
         for section_key, section_values in pairs(signal.modem.signal) do
           for key, value in pairs(section_values) do
-            if value ~='--' then
+            if value ~= '--' then
               if utils.is_table_empty(info.signal[section_key]) then
-                info.signal[section_key]={}
+                info.signal[section_key] = {}
               end
-              info.signal[section_key][key]=tonumber(value)
+              info.signal[section_key][key] = tonumber(value)
             end
           end
         end
       end
     end
 
-    return {type='modem-manager', mobile=info}
+    return {type = 'modem-manager', mobile = info}
   end
 }
 
 function interfaces.find_default_gateway(routes)
-  for i=1, #routes do
-    if routes[i].target=='0.0.0.0' then
-      return routes[i].nexthop
-    end
+  for i = 1, #routes do
+    if routes[i].target == '0.0.0.0' then return routes[i].nexthop end
   end
   return nil
 end
 
 function interfaces.new_address_array(address, interface, family)
-  local proto=interface['proto']
-  if proto=='dhcpv6' then
-    proto='dhcp'
-  end
-  local new_address={
-    address=address['address'],
-    mask=address['mask'],
-    proto=proto,
-    family=family,
-    gateway=interfaces.find_default_gateway(interface.route)
+  local proto = interface['proto']
+  if proto == 'dhcpv6' then proto = 'dhcp' end
+  local new_address = {
+    address = address['address'],
+    mask = address['mask'],
+    proto = proto,
+    family = family,
+    gateway = interfaces.find_default_gateway(interface.route)
   }
   return new_address
 end
 
 -- collect interface addresses
 function interfaces.get_addresses(name)
-  local addresses={}
-  local proto=nil
-  local interface_list=interface_data['interface']
-  local addresses_list={}
+  local addresses = {}
+  local proto = nil
+  local interface_list = interface_data['interface']
+  local addresses_list = {}
   for _, interface in pairs(interface_list) do
-    if interface['l3_device']==name then
+    if interface['l3_device'] == name then
       for _, address in pairs(interface['ipv4-address']) do
         table.insert(addresses_list, address['address'])
-        local new_address=interfaces.new_address_array(address, interface, 'ipv4')
+        local new_address = interfaces.new_address_array(address, interface, 'ipv4')
         table.insert(addresses, new_address)
       end
       for _, address in pairs(interface['ipv6-address']) do
         table.insert(addresses_list, address['address'])
-        local new_address=interfaces.new_address_array(address, interface, 'ipv6')
+        local new_address = interfaces.new_address_array(address, interface, 'ipv6')
         table.insert(addresses, new_address)
       end
     end
   end
-  for i=1, #nixio_data do
-    if nixio_data[i].name==name then
+  for i = 1, #nixio_data do
+    if nixio_data[i].name == name then
       if not utils.is_excluded(name) then
-        local family=nixio_data[i].family
-        local addr=nixio_data[i].addr
-        if family=='inet' then
-          family='ipv4'
+        local family = nixio_data[i].family
+        local addr = nixio_data[i].addr
+        if family == 'inet' then
+          family = 'ipv4'
           -- Since we don't already know this from the dump, we can
           -- consider this dynamically assigned, this is the case for
           -- example for OpenVPN interfaces, which get their address
           -- from the DHCP server embedded in OpenVPN
-           proto='dhcp'
-        elseif family=='inet6' then
-          family='ipv6'
+          proto = 'dhcp'
+        elseif family == 'inet6' then
+          family = 'ipv6'
           if utils.starts_with(addr, 'fe80') then
-            proto='static'
+            proto = 'static'
           else
-            local ula=uci_cursor.get('network', 'globals', 'ula_prefix')
-            local ula_prefix=utils.split(ula, '::')[1]
+            local ula = uci_cursor.get('network', 'globals', 'ula_prefix')
+            local ula_prefix = utils.split(ula, '::')[1]
             if utils.starts_with(addr, ula_prefix) then
-              proto='static'
+              proto = 'static'
             else
-              proto='dhcp'
+              proto = 'dhcp'
             end
           end
         end
-        if family=='ipv4' or family=='ipv6' then
+        if family == 'ipv4' or family == 'ipv6' then
           if not utils.has_value(addresses_list, addr) then
             table.insert(addresses, {
-              address=addr,
-              mask=nixio_data[i].prefix,
-              proto=proto,
-              family=family
+              address = addr,
+              mask = nixio_data[i].prefix,
+              proto = proto,
+              family = family
             })
           end
         end
@@ -158,25 +154,22 @@ function interfaces.get_addresses(name)
 end
 
 function interfaces.get_interface_info(name, netjson_interface)
-  local info={
-    dns_search=nil,
-    dns_servers=nil
-  }
+  local info = {dns_search = nil, dns_servers = nil}
   for _, interface in pairs(interface_data['interface']) do
-    if interface['l3_device']==name then
+    if interface['l3_device'] == name then
       if next(interface['dns-search']) then
-        info.dns_search=interface['dns-search']
+        info.dns_search = interface['dns-search']
       end
       if next(interface['dns-server']) then
-        info.dns_servers=interface['dns-server']
+        info.dns_servers = interface['dns-server']
       end
-      if netjson_interface.type=='bridge' then
-        info.stp=uci_cursor.get('network', interface['interface'], 'stp')=='1'
+      if netjson_interface.type == 'bridge' then
+        info.stp = uci_cursor.get('network', interface['interface'], 'stp') == '1'
       end
       -- collect specialized info if available
-      local specialized_info=specialized_interfaces[interface.proto]
+      local specialized_info = specialized_interfaces[interface.proto]
       if specialized_info then
-        info.specialized=specialized_info(name, interface)
+        info.specialized = specialized_info(name, interface)
       end
     end
   end
@@ -185,17 +178,13 @@ end
 
 function interfaces.get_vpn_interfaces()
   -- only openvpn supported for now
-  local items=uci_cursor:get_all('openvpn')
-  local vpn_interfaces={}
+  local items = uci_cursor:get_all('openvpn')
+  local vpn_interfaces = {}
 
-  if utils.is_table_empty(items) then
-    return {}
-  end
+  if utils.is_table_empty(items) then return {} end
 
   for _, config in pairs(items) do
-    if config and config.dev then
-      vpn_interfaces[config.dev]=true
-    end
+    if config and config.dev then vpn_interfaces[config.dev] = true end
   end
   return vpn_interfaces
 end