Skip to content

[fix] Fix remote configuration getting stored if backup not available #153 #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nemesifier merged 5 commits into from
Dec 15, 2021
Merged

[fix] Fix remote configuration getting stored if backup not available #153 #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6f769f3
[refactor] Use stored dir for storing configuration
devkapilbansal Nov 24, 2021
09e8c24
[fix] Fix configuration files not getting removed #153
devkapilbansal Nov 24, 2021
a57f06f
[change] Remove options and sections coming from remote configuration
devkapilbansal Nov 29, 2021
d6f2b0f
[tests] Added tests
devkapilbansal Nov 29, 2021
9f02107
[refactor] Remove unnecessary if block
devkapilbansal Dec 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions openwisp-config/files/sbin/openwisp-update-config.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ 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 stored_config_dir = openwisp_dir .. '/etc/config'
local stored_config_dir = stored_dir .. '/etc/config'
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
Expand Down Expand Up @@ -84,8 +84,8 @@ if lfs.attributes(remote_config_dir, 'mode') == 'directory' then
if section_stored == nil then
utils.remove_uci_options(standard, file, section)
-- section is in the backup configuration -> restore
-- delete all options first
else
-- delete all options first
for option, value in pairs(section) do
if not utils.starts_with_dot(option) then
standard:delete(file, section['.name'], option)
Expand Down Expand Up @@ -150,6 +150,33 @@ if lfs.attributes(remote_config_dir, 'mode') == 'directory' then
-- if there's no backup of the file yet, create one
if not utils.file_exists(stored_path) then
os.execute('cp '..standard_path..' '..stored_path)
for key, section in pairs(stored:get_all(file)) do
-- check if section is in remote configuration
local section_check = check:get(file, section['.name'])
if section_check then
-- check if options is in remote configuration
for option, value in pairs(section) do
if not utils.starts_with_dot(option) then
local option_check = check:get(file, section['.name'], option)
if option_check then
-- if option is in remote configuration, remove it
stored:delete(file, section['.name'], option)
end
end
end
-- remove entire section if empty
local result = stored:get_all(file, section['.name'])
if result and utils.is_uci_empty(result) then
stored:delete(file, section['.name'])
end
end
end
stored:commit(file)
-- remove uci file if empty
local uci_file = stored:get_all(file)
if uci_file and utils.is_table_empty(uci_file) then
os.remove(stored_path)
end
end
-- MERGE mode
if MERGE then
Expand Down
Binary file modified openwisp-config/tests/good-config.tar.gz
View file
Open in desktop
Binary file not shown.
48 changes: 31 additions & 17 deletions openwisp-config/tests/test_update_config.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ local update_config = assert(loadfile("../files/sbin/openwisp-update-config.lua"
local write_dir = './update-test/'
local config_dir = write_dir .. 'etc/config/'
local openwisp_dir = './openwisp/'
local stored_dir = openwisp_dir .. '/stored/'
local remote_config_dir = openwisp_dir .. 'remote/etc/config'

local function string_count(base, pattern)
Expand Down Expand Up @@ -38,8 +39,8 @@ TestUpdateConfig = {
os.execute('echo restore-me > '..openwisp_dir..'/stored/etc/restore-me')
os.execute('echo /etc/restore-me > '..openwisp_dir..'/modified.list')
-- this file is stored in the backup
os.execute('mkdir -p ' .. openwisp_dir ..'etc/config/')
os.execute("cp ./update/stored_wireless " ..openwisp_dir.. '/etc/config/wireless')
os.execute('mkdir -p ' .. stored_dir ..'etc/config/')
os.execute("cp ./update/stored_wireless " ..stored_dir.. '/etc/config/wireless')
end,
tearDown = function()
os.execute('rm -rf ' .. write_dir)
Expand All @@ -54,8 +55,21 @@ function TestUpdateConfig.test_update()
local networkFile = io.open(config_dir .. 'network')
luaunit.assertNotNil(networkFile)
local networkContents = networkFile:read('*all')
-- ensure interface added is present
luaunit.assertNotNil(string.find(networkContents, "config interface 'added'"))
luaunit.assertNotNil(string.find(networkContents, "option ifname 'added0'"))
-- ensure wg1 added via remote previously is present
luaunit.assertNotNil(string.find(networkContents, "config interface 'wg1'"))
luaunit.assertNotNil(string.find(networkContents, "option proto 'static'"))
-- ensure network file is stored for backup
local storedNetworkFile = io.open(stored_dir .. '/etc/config/network')
luaunit.assertNotNil(storedNetworkFile)
local storedNetworkContents = storedNetworkFile:read('*all')
-- ensure wg1 is not added that is downloaded from remote
luaunit.assertNil(string.find(storedNetworkContents, "config interface 'wg1'"))
-- ensure wan and wg0 are present
luaunit.assertNotNil(string.find(storedNetworkContents, "config interface 'wan'"))
luaunit.assertNotNil(string.find(storedNetworkContents, "config interface 'wg0'"))
-- check system
local systemFile = io.open(config_dir .. 'system')
luaunit.assertNotNil(systemFile)
Expand All @@ -68,6 +82,16 @@ function TestUpdateConfig.test_update()
-- ensure rest of config options are present
luaunit.assertNotNil(string.find(systemContents, "config timeserver 'ntp'"))
luaunit.assertNotNil(string.find(systemContents, "list server '3.openwrt.pool.ntp.org'"))
-- ensure system file is stored for backup
local storedSystemFile = io.open(stored_dir .. '/etc/config/network')
luaunit.assertNotNil(storedSystemFile)
local storedSystemContents = storedSystemFile:read('*all')
-- ensure hostname is not added that is updated from remote
luaunit.assertNil(string.find(storedSystemContents, "option hostname"))
-- ensure custom is not added that is downloaded from remote
luaunit.assertNil(string.find(storedSystemContents, "option custom 'custom'"))
-- ensure new is not added that is downloaded from remote
luaunit.assertNil(string.find(storedSystemContents, "config new 'new'"))
-- ensure test file is present
local testFile = io.open(write_dir .. 'etc/test')
luaunit.assertNotNil(testFile)
Expand Down Expand Up @@ -108,7 +132,7 @@ function TestUpdateConfig.test_update()
local modifiedListFile = io.open(openwisp_dir .. '/modified.list')
luaunit.assertNotNil(modifiedListFile)
luaunit.assertEquals(modifiedListFile:read('*all'), '/etc/existing\n')
local storedExisitngFile = io.open(openwisp_dir .. '/stored/etc/existing')
local storedExisitngFile = io.open(stored_dir .. '/etc/existing')
luaunit.assertNotNil(storedExisitngFile)
luaunit.assertEquals(storedExisitngFile:read('*all'), 'original\n')
-- ensure it has been modified
Expand All @@ -121,17 +145,7 @@ function TestUpdateConfig.test_update()
local restoreFile = io.open(write_dir..'/etc/restore-me')
luaunit.assertNotNil(restoreFile)
luaunit.assertEquals(restoreFile:read('*all'), 'restore-me\n')
luaunit.assertNil(io.open(openwisp_dir..'/stored/etc/restore-me'))
-- ensure network configuration file is backed up
local storedNetworkFile = io.open(openwisp_dir .. '/etc/config/network')
luaunit.assertNotNil(storedNetworkFile)
local initialNetworkFile = io.open('update/network')
luaunit.assertEquals(storedNetworkFile:read('*all'), initialNetworkFile:read('*all'))
-- ensure system configuration file is backed up
local storedSystemFile = io.open(openwisp_dir .. '/etc/config/system')
luaunit.assertNotNil(storedSystemFile)
local initialSystemFile = io.open('update/system')
luaunit.assertEquals(storedSystemFile:read('*all'), initialSystemFile:read('*all'))
luaunit.assertNil(io.open(stored_dir .. '/etc/restore-me'))
end

function TestUpdateConfig.test_update_conf_arg()
Expand Down Expand Up @@ -164,7 +178,7 @@ function TestUpdateConfig.test_duplicate_list_options()
luaunit.assertEquals(string_count(networkContents, "list ipaddr '192.168.10.3/24'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.2'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.3'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.4'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.4'"), 2)
luaunit.assertNotNil(string.find(networkContents, "option test_restore '2'"))
-- repeating the operation has the same result
update_config('--test=1', '--conf=./test-duplicate-list.tar.gz')
Expand All @@ -176,7 +190,7 @@ function TestUpdateConfig.test_duplicate_list_options()
luaunit.assertEquals(string_count(networkContents, "list ipaddr '192.168.10.3/24'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.2'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.3'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.4'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.4'"), 2)
luaunit.assertNotNil(string.find(networkContents, "option test_restore '2'"))
end

Expand All @@ -191,7 +205,7 @@ function TestUpdateConfig.test_removal_list_options()
luaunit.assertEquals(string_count(networkContents, "list ipaddr '192.168.10.3/24'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.2'"), 0)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.3'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.4'"), 1)
luaunit.assertEquals(string_count(networkContents, "list addresses '10.0.0.4'"), 2)
luaunit.assertNotNil(string.find(networkContents, "option test_restore '2'"))
end

Expand Down
5 changes: 5 additions & 0 deletions openwisp-config/tests/update/network
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ config interface 'wan'
config interface 'wg0'
list addresses '10.0.0.2'
list addresses '10.0.0.3'

config interface 'wg1'
option proto 'static'
list addresses '10.0.0.4'
list addresses '10.0.0.5'