Merge pull request #96 from TPath123/luacheck

[luacheck] Run luacheck on all files and fix warnings

Author: nemesifier

.luacheckrc

@@ -0,0 +1,4 @@
+ignore = {"213/_.*"} -- unused Loop Variables beginning with underscore
+files["openwisp-config/tests"] = {
+    ignore = {"11./Test.*"} -- globals relating to defining unittests
+}

openwisp-config/files/lib/openwisp/net.lua

@@ -4,7 +4,7 @@ local net = {}
 
 function net.get_interface(name, family)
     local uci_cursor = uci.cursor()
-    local family = family or 'inet'
+    local ip_family = family or 'inet'
     -- if UCI network name is a bridge, the ifname won't be the name of the bridge
     local is_bridge = uci_cursor:get('network', name, 'type') == 'bridge'
     local ifname
@@ -17,8 +17,8 @@ function net.get_interface(name, family)
     end
     -- get list of interfaces and loop until found
     local interfaces = nixio.getifaddrs()
-    for i, interface in pairs(interfaces) do
-        if interface.name == ifname and interface.family == family then
+    for _, interface in pairs(interfaces) do
+        if interface.name == ifname and interface.family == ip_family then
             return interface
         end
     end

openwisp-config/files/lib/openwisp/utils.lua

@@ -30,18 +30,18 @@ end
 
 function utils.dirname(path)
     local parts = utils.split(path, '/')
-    local path = '/'
+    local returnPath = '/'
     local length = table.getn(parts)
     for i, part in ipairs(parts) do
         if i < length then
-            path = path..part..'/'
+            returnPath = returnPath..part..'/'
         end
     end
-    return path
+    return returnPath
 end
 
 function utils.add_values_to_set(set, values)
-    for i, el in pairs(values) do
+    for _, el in pairs(values) do
         set[el] = true
     end
     return set
@@ -142,10 +142,10 @@ end
 
 -- Code by David Kastrup
 -- http://lua-users.org/wiki/DirTreeIterator
-function utils.dirtree(dir)
-    assert(dir and dir ~= '', 'directory parameter is missing or empty')
-    if string.sub(dir, -1) == '/' then
-        local dir = string.sub(dir, 1, -2)
+function utils.dirtree(dirParam)
+    assert(dirParam and dirParam ~= '', 'directory parameter is missing or empty')
+    if string.sub(dirParam, -1) == '/' then
+        dirParam = string.sub(dirParam, 1, -2)
     end
     local function yieldtree(dir)
         for entry in lfs.dir(dir) do
@@ -159,7 +159,7 @@ function utils.dirtree(dir)
             end
         end
     end
-    return coroutine.wrap(function() yieldtree(dir) end)
+    return coroutine.wrap(function() yieldtree(dirParam) end)
 end
 
 function utils.file_exists(path)

openwisp-config/files/sbin/openwisp-remove-default-wifi.lua

@@ -1,11 +1,12 @@
 #!/usr/bin/env lua
 -- removes OpenWrt/LEDE default wifi-iface settings, if present
 
-require('uci')
+local uci = require('uci')
 
 -- parse arguments
+local test
 local arg={...}
-for key, value in pairs(arg) do
+for _, value in pairs(arg) do
     -- test argument
     if value == '--test=1' then test = true; end
 end
@@ -16,7 +17,7 @@ local standard_path = standard_prefix .. 'config/'
 local standard = uci.cursor(standard_path)
 local changed = false
 
-function is_default_wifi(section)
+local function is_default_wifi(section)
     if section.encryption == 'none' and
        section.mode == 'ap'         and
        section.network == 'lan'     and

openwisp-config/files/sbin/openwisp-restore-unmanaged.lua

@@ -1,10 +1,12 @@
 #!/usr/bin/env lua
 -- restores unmanaged configurations
 
-require('uci')
+local uci = require('uci')
+local lfs = require('lfs')
 local utils = require('openwisp.utils')
 
 -- parse arguments
+local test = false
 local arg={...}
 for key, value in pairs(arg) do
     -- test argument

openwisp-config/files/sbin/openwisp-store-unmanaged.lua

@@ -1,14 +1,15 @@
 #!/usr/bin/env lua
 -- stores unmanaged configurations
 
-require('os')
-require('io')
-require('uci')
+local os = require('os')
+local io = require('io')
+local uci = require('uci')
 local utils = require('openwisp.utils')
 local sections
 local arg={...}
 
 -- parse arguments
+local test = false
 for key, value in pairs(arg) do
     -- test argument
     if value == '--test=1' then test = true; end
@@ -25,7 +26,7 @@ local standard_path = standard_prefix .. 'config/'
 local unmanaged_path = unmanaged_prefix .. 'unmanaged/'
 local uci_tmp_path = '/tmp/openwisp/.uci'
 
-function empty_file(path)
+local function empty_file(path)
     local file = io.open(path, 'w')
     file:write('')
     file:close()
@@ -46,7 +47,7 @@ end
 -- }
 local unmanaged_map = {}
 local section_list = utils.split(sections)
-for i, section in pairs(section_list) do
+for _, section in pairs(section_list) do
     local parts = utils.split(section, '.')
     -- skip unrecognized strings
     if parts[1] and parts[2] then
@@ -64,7 +65,7 @@ for i, section in pairs(section_list) do
             if not unmanaged_map[config] then
                 unmanaged_map[config] = {}
             end
-            el = {name=section_name, type=section_type}
+            local el = {name=section_name, type=section_type}
             table.insert(unmanaged_map[config], el)
         end
     end

openwisp-config/files/sbin/openwisp-update-config.lua

@@ -1,50 +1,50 @@
 #!/usr/bin/env lua
 -- openwisp-config configuration updater
 
-require('os')
-require('lfs')
-require('uci')
+local os = require('os')
+local lfs = require('lfs')
+local uci = require('uci')
 local utils = require('openwisp.utils')
 local arg = {...}
 
 -- parse arguments
-MERGE = true
-TEST = false
-for key, value in pairs(arg) do
+local MERGE = true
+local TEST = false
+for _, value in pairs(arg) do
     -- test argument
     if value == '--merge=0' then MERGE = false; end
     if value == '--test=1' then TEST = true; end
 end
 
-working_dir = lfs.currentdir()
-tmp_dir = not TEST and '/tmp/openwisp' or working_dir
-check_dir = tmp_dir .. '/check'
-check_config_dir = check_dir..'/etc/config'
-downloaded_conf = tmp_dir .. '/configuration.tar.gz'
-openwisp_dir = not TEST and '/etc/openwisp' or working_dir .. '/openwisp'
-standard_config_dir = not TEST and '/etc/config' or working_dir .. '/update-test/etc/config'
-test_root_dir = working_dir .. '/update-test'
-remote_dir = openwisp_dir .. '/remote'
-remote_config_dir = remote_dir .. '/etc/config'
-stored_dir = openwisp_dir .. '/stored'
-added_file = openwisp_dir .. '/added.list'
-modified_file = openwisp_dir .. '/modified.list'
-get_standard = function() return uci.cursor(standard_config_dir) end
-get_remote = function() return uci.cursor(remote_config_dir, '/tmp/openwisp/.uci') end
-get_check = function() return uci.cursor(check_config_dir, '/tmp/openwisp/.uci') end
+local working_dir = lfs.currentdir()
+local tmp_dir = not TEST and '/tmp/openwisp' or working_dir
+local check_dir = tmp_dir .. '/check'
+local check_config_dir = check_dir..'/etc/config'
+local downloaded_conf = tmp_dir .. '/configuration.tar.gz'
+local openwisp_dir = not TEST and '/etc/openwisp' or working_dir .. '/openwisp'
+local standard_config_dir = not TEST and '/etc/config' or working_dir .. '/update-test/etc/config'
+local test_root_dir = working_dir .. '/update-test'
+local remote_dir = openwisp_dir .. '/remote'
+local remote_config_dir = remote_dir .. '/etc/config'
+local stored_dir = openwisp_dir .. '/stored'
+local added_file = openwisp_dir .. '/added.list'
+local modified_file = openwisp_dir .. '/modified.list'
+local get_standard = function() return uci.cursor(standard_config_dir) end
+local get_remote = function() return uci.cursor(remote_config_dir, '/tmp/openwisp/.uci') end
+local get_check = function() return uci.cursor(check_config_dir, '/tmp/openwisp/.uci') end
 
 -- uci cursors
-standard = get_standard()
-remote = get_remote()
+local standard = get_standard()
+local remote = get_remote()
 
 -- check downloaded UCI files before proceeding
 os.execute('mkdir -p '..check_dir)
 os.execute('tar -zxf '..downloaded_conf..' -C '..check_dir)
-check = get_check()
+local check = get_check()
 
 if lfs.attributes(check_config_dir, 'mode') == 'directory' then
     for file in lfs.dir(check_config_dir) do
-        path = check_config_dir..'/'..file
+        local path = check_config_dir..'/'..file
         if lfs.attributes(path, 'mode') == 'file' then
             if check:get_all(file) == nil then
                 print('ERROR: invalid UCI configuration file: '..file)
@@ -67,7 +67,7 @@ if lfs.attributes(remote_config_dir, 'mode') == 'directory' then
     for file in lfs.dir(remote_config_dir) do
         local standard_path = standard_config_dir .. '/' .. file
         if lfs.attributes(standard_path, 'mode') == 'file' then
-            for key, section in pairs(remote:get_all(file)) do
+            for _, section in pairs(remote:get_all(file)) do
                 -- search section in the downloaded configuration
                 local section_check = check:get(file, section['.name'])
                 -- remove section from current configuration if not in downloaded configuration
@@ -92,8 +92,8 @@ if lfs.attributes(remote_config_dir, 'mode') == 'directory' then
             end
             standard:commit(file)
             -- remove uci file if empty
-            local uci = standard:get_all(file)
-            if uci and utils.is_table_empty(uci) then
+            local uciFile = standard:get_all(file)
+            if uciFile and utils.is_table_empty(uciFile) then
                 os.remove(standard_path)
             end
         end
@@ -120,7 +120,7 @@ if lfs.attributes(remote_config_dir, 'mode') == 'directory' then
             if MERGE then
                 -- avoid "file does not exist" error
                 os.execute('touch ' .. standard_path)
-                for key, section in pairs(remote:get_all(file)) do
+                for _, section in pairs(remote:get_all(file)) do
                     utils.write_uci_section(standard, file, section)
                 end
                 standard:commit(file)
@@ -136,14 +136,14 @@ end
 os.execute('touch ' .. added_file)
 os.execute('touch ' .. modified_file)
 -- convert lists to lua sets
-added = utils.file_to_set(added_file)
-modified = utils.file_to_set(modified_file)
-added_changed = false
-modified_changed = false
+local added = utils.file_to_set(added_file)
+local modified = utils.file_to_set(modified_file)
+local added_changed = false
+local modified_changed = false
 
 -- loop each file except directories and standard UCI config files
-ignored_path = remote_config_dir .. '/'
-function is_ignored(path)
+local ignored_path = remote_config_dir .. '/'
+local function is_ignored(path)
     return utils.starts_with(path, ignored_path)
 end
 

openwisp-config/tests/test_remove_default_wifi.lua

@@ -1,7 +1,7 @@
 require('os')
 require('io')
-luaunit = require('luaunit')
-remove_default_wifi = assert(loadfile("../files/sbin/openwisp-remove-default-wifi.lua"))
+local luaunit = require('luaunit')
+local remove_default_wifi = assert(loadfile("../files/sbin/openwisp-remove-default-wifi.lua"))
 
 TestRemoveDefaultWifi = {
     setUp = function()

openwisp-config/tests/test_restore_unmanaged.lua

@@ -2,9 +2,9 @@
 package.path = package.path .. ';../files/lib/?.lua'
 require('os')
 require('io')
-luaunit = require('luaunit')
-restore_unmanaged = assert(loadfile("../files/sbin/openwisp-restore-unmanaged.lua"))
-write_dir = './unmanaged/'
+local luaunit = require('luaunit')
+local restore_unmanaged = assert(loadfile("../files/sbin/openwisp-restore-unmanaged.lua"))
+local write_dir = './unmanaged/'
 
 TestRestoreUnmanaged = {
     setUp = function()

openwisp-config/tests/test_store_unmanaged.lua

@@ -2,20 +2,20 @@
 package.path = package.path .. ';../files/lib/?.lua'
 require('os')
 require('io')
-luaunit = require('luaunit')
-store_unmanaged = assert(loadfile("../files/sbin/openwisp-store-unmanaged.lua"))
-default_blocks = "system.ntp " ..
+local luaunit = require('luaunit')
+local store_unmanaged = assert(loadfile("../files/sbin/openwisp-store-unmanaged.lua"))
+local default_blocks = "system.ntp " ..
                  "system.@led " ..
                  "network.loopback " ..
                  "network.@globals " ..
                  "network.lan " ..
                  "network.wan " ..
                  "network.@switch " ..
                  "network.@switch_vlan"
-write_dir = './unmanaged/'
-assertNotNil = luaunit.assertNotNil
-assertNil = luaunit.assertNil
-assertEquals = luaunit.assertEquals
+local write_dir = './unmanaged/'
+local assertNotNil = luaunit.assertNotNil
+local assertNil = luaunit.assertNil
+local assertEquals = luaunit.assertEquals
 
 local function _clean()
     os.remove(write_dir .. 'network')
@@ -37,27 +37,27 @@ end
 function TestStoreUnmanaged.test_default()
     store_unmanaged('--test=1', '-o=' .. default_blocks)
     -- ensure network config file has been created correctly
-    local file = io.open(write_dir .. 'network')
-    assertNotNil(file)
-    local contents = file:read('*all')
-    assertNotNil(string.find(contents, "config interface 'loopback'"))
-    assertNotNil(string.find(contents, "option ipaddr '127.0.0.1'"))
-    assertNotNil(string.find(contents, "option ula_prefix 'fd8e:f40a:6701::/48'"))
-    assertNotNil(string.find(contents, "config interface 'wan'"))
-    assertNotNil(string.find(contents, "config switch"))
-    assertNotNil(string.find(contents, "option vlan '2'"))
-    assertNotNil(string.find(contents, "option vlan '1'"))
-    assertNil(string.find(contents, "config interface 'wlan0'"))
-    assertNil(string.find(contents, "config interface 'wlan1'"))
+    local networkFile = io.open(write_dir .. 'network')
+    assertNotNil(networkFile)
+    local networkContents = networkFile:read('*all')
+    assertNotNil(string.find(networkContents, "config interface 'loopback'"))
+    assertNotNil(string.find(networkContents, "option ipaddr '127.0.0.1'"))
+    assertNotNil(string.find(networkContents, "option ula_prefix 'fd8e:f40a:6701::/48'"))
+    assertNotNil(string.find(networkContents, "config interface 'wan'"))
+    assertNotNil(string.find(networkContents, "config switch"))
+    assertNotNil(string.find(networkContents, "option vlan '2'"))
+    assertNotNil(string.find(networkContents, "option vlan '1'"))
+    assertNil(string.find(networkContents, "config interface 'wlan0'"))
+    assertNil(string.find(networkContents, "config interface 'wlan1'"))
     -- ensure system config file exists
-    local file = io.open(write_dir .. 'system')
-    assertNotNil(file)
-    local contents = file:read('*all')
-    assertNotNil(string.find(contents, "list server '1.openwrt.pool.ntp.org'"))
-    assertNotNil(string.find(contents, "config led 'led_usb1'"))
-    assertNotNil(string.find(contents, "config led 'led_usb2'"))
-    assertNotNil(string.find(contents, "config led 'led_wlan2g'"))
-    assertNil(string.find(contents, "option hostname 'OpenWrt'"))
+    local systemFile = io.open(write_dir .. 'system')
+    assertNotNil(systemFile)
+    local systemContents = systemFile:read('*all')
+    assertNotNil(string.find(systemContents, "list server '1.openwrt.pool.ntp.org'"))
+    assertNotNil(string.find(systemContents, "config led 'led_usb1'"))
+    assertNotNil(string.find(systemContents, "config led 'led_usb2'"))
+    assertNotNil(string.find(systemContents, "config led 'led_wlan2g'"))
+    assertNil(string.find(systemContents, "option hostname 'OpenWrt'"))
 end
 
 function TestStoreUnmanaged.test_specific_name()