Module:Sensitive IP addresses/list/validate - Revision history

Mr. Stradivarius: make description a required field

2016-09-22T09:50:05Z

make description a required field

← Previous revision		Revision as of 09:50, 22 September 2016
Line 67:		Line 67:

	-- Check that we have required string fields.		-- Check that we have required string fields.
	for _, field in ipairs{'name', 'id'} do		for _, field in ipairs{'name', 'id', 'description'} do
	if type(subtable[field]) ~= 'string' then		if type(subtable[field]) ~= 'string' then
	logger:addError(		logger:addError(
Line 84:		Line 84:

	-- Check that optional string fields are strings if they are present.		-- Check that optional string fields are strings if they are present.
	for _, field in ipairs{~~'description',~~ 'notes'} do		for _, field in ipairs{'notes'} do
	local val = subtable[field]		local val = subtable[field]
	if val ~= nil and type(val) ~= 'string' then		if val ~= nil and type(val) ~= 'string' then

Mr. Stradivarius: fix getSensitivityReasons function format

2016-08-23T12:46:27Z

fix getSensitivityReasons function format

← Previous revision		Revision as of 12:46, 23 August 2016
Line 104:		Line 104:
	"The reason field in data entry #%d was invalid (should be '%s')",		"The reason field in data entry #%d was invalid (should be '%s')",
	dataIndex,		dataIndex,
		⚫	mSIPA_API._getSensitivityReasons("', '", "', or '")
	mw.text.listToText(
⚫	mSIPA_API._getSensitivityReasons(),
	"', '",
	"', or '"
	)
	)		)
	end		end

Mr. Stradivarius: fix module and function name errors

2016-08-23T10:01:24Z

fix module and function name errors

← Previous revision		Revision as of 10:01, 23 August 2016
Line 2:		Line 2:

	-- Load modules		-- Load modules
	local ~~mSensitiveIPs~~ = require('Module:Sensitive IP addresses')		local mSIPA_API = require('Module:Sensitive IP addresses/API')
	local Subnet = require('Module:IP').Subnet		local Subnet = require('Module:IP').Subnet

Line 100:		Line 100:
	'string or nil'		'string or nil'
	)		)
	elseif not ~~mSensitiveIPs~~.~~isValidSensitivityReason~~(subtable.reason) then		elseif not mSIPA_API._isValidSensitivityReason(subtable.reason) then
	logger:addError(		logger:addError(
	"The reason field in data entry #%d was invalid (should be '%s')",		"The reason field in data entry #%d was invalid (should be '%s')",
	dataIndex,		dataIndex,
	mw.text.listToText(		mw.text.listToText(
	~~mSensitiveIPs~~.~~getSensitivityReasons~~(),		mSIPA_API._getSensitivityReasons(),
	"', '",		"', '",
	"', or '"		"', or '"

Mr. Stradivarius: fix bad function call

2016-07-31T07:19:13Z

fix bad function call

← Previous revision		Revision as of 07:19, 31 July 2016
Line 105:		Line 105:
	dataIndex,		dataIndex,
	mw.text.listToText(		mw.text.listToText(
	mSensitiveIPs.getSensitivityReasons,		mSensitiveIPs.getSensitivityReasons(),
	"', '",		"', '",
	"', or '"		"', or '"

Mr. Stradivarius: more grammatical error messages

2016-07-26T02:25:22Z

more grammatical error messages

← Previous revision		Revision as of 02:25, 26 July 2016
Line 70:		Line 70:
	if type(subtable[field]) ~= 'string' then		if type(subtable[field]) ~= 'string' then
	logger:addError(		logger:addError(
	~~'Data~~ ~~entry~~ #%d ~~does~~ ~~not~~ ~~have a~~ %~~s field'~~,		"Missing field '%s' in data entry #%d",
	~~dataIndex~~,		field,
	~~field~~		dataIndex
	)		)
	elseif subtable[field] == '' then		elseif subtable[field] == '' then
	logger:addError(		logger:addError(
	~~'Data~~ ~~entry~~ #%d ~~has~~ a ~~blank~~ %~~s field'~~,		"Blank field '%s' in data entry #%d",
	~~dataIndex~~,		field,
	~~field~~		dataIndex
	)		)
	end		end

Mr. Stradivarius: add check for duplicate IDs

2016-07-26T02:20:58Z

add check for duplicate IDs

@@ Line 66: / Line 66: @@
 		end
-		-- Check that we have a name for the entry.
+		-- Check that we have required string fields.
-		if type(subtable.name) ~= 'string' then
+			if type(subtable[field]) ~= 'string' then
-			logger:addError('Data entry #%d has a blank name field', dataIndex)
+					'Data entry #%d does not have a %s field',
 		end
@@ Line 135: / Line 145: @@
 	if success then
 		return obj
 	end
 end
@@ Line 221: / Line 250: @@
 		return logger:makeReport()
 	end
 	checkRanges(logger, data)
 	return logger:makeReport()

Mr. Stradivarius: check for wrong IP version

2016-07-24T23:21:34Z

check for wrong IP version

← Previous revision		Revision as of 23:21, 24 July 2016
Line 155:		Line 155:
	local subnet = makeSubnet(cidr)		local subnet = makeSubnet(cidr)
	if subnet then		if subnet then
	~~table.insert(ranges[~~field~~:gsub(~~'~~Ranges~~', ''~~)],~~ {		local ipVersion = field == 'ipv4Ranges' and 'IPv4' or 'IPv6'
	~~dataIndex~~ = ~~dataIndex,~~		local rangeKey = ipVersion:lower()
			if ipVersion == subnet:getVersion() then
⚫	~~field~~ = ~~field~~,
			table.insert(ranges[rangeKey], {
	rangeIndex = j,
	~~subnet~~ = ~~subnet~~,		dataIndex = dataIndex,
	~~name~~ = ~~subtable.name~~,		field = field,
	})		rangeIndex = j,
		⚫	subnet = subnet,
			name = subtable.name,
			})
			else
			logger:addError(
			"Found %s CIDR string '%s' in range #%d in the %s field of entry #%d (%s); should be %s",
			subnet:getVersion(), cidr, j, field, dataIndex, subtable.name, ipVersion
			)
			end
	else		else
	logger:addError(		logger:addError(

Mr. Stradivarius: check for overlapping subnets

2016-07-24T13:40:56Z

check for overlapping subnets

@@ Line 59: / Line 59: @@
 local function checkDataStructure(logger, data)
-	-- Checks the structure of individual entries.
+	-- Check the structure of the individual entries in the data table.
 	for dataIndex, subtable in ipairs(data) do
 		-- Check that subtables are tables.
@@ Line 127: / Line 127: @@
 		end
 	end
 end
@@ Line 136: / Line 209: @@
 	end
 	checkDataStructure(logger, data)
 	return logger:makeReport()
 end

Mr. Stradivarius: indentation fix

2016-07-24T11:12:17Z

indentation fix

← Previous revision		Revision as of 11:12, 24 July 2016
Line 108:		Line 108:
	if ranges ~= nil then		if ranges ~= nil then
	if type(ranges) ~= 'table' then		if type(ranges) ~= 'table' then
	logger:addEntryTypeError(dataIndex, field, type(ranges), 'table or nil')		logger:addEntryTypeError(dataIndex, field, type(ranges), 'table or nil')
	else		else
	for j, range in ipairs(ranges) do		for j, range in ipairs(ranges) do

Mr. Stradivarius: validate structure of Module:Sensitive IP addresses/list

2016-07-24T11:11:32Z

validate structure of Module:Sensitive IP addresses/list

New page

-- This module validates the data in [[Module:Sensitive IP addresses/list]].

-- Load modules
local mSensitiveIPs = require('Module:Sensitive IP addresses')
local Subnet = require('Module:IP').Subnet

-- Constants
local DATA_MODULE = 'Module:Sensitive IP addresses/list'

local p = {}

local function makeErrorLogger()
-- Return an object for formatting errors.
return {
errors = {},
addError = function (self, msg, ...)
table.insert(self.errors, string.format(msg, ...))
end,
addEntryTypeError = function (self, entryIdx, field, actual, expected)
self:addError(
'The %s field in data entry #%d was type %s (should be string or nil)',
field, entryIdx, actual, expected
)
end,
hasErrors = function (self)
return #self.errors > 0
end,
makeReport = function (self)
if #self.errors < 1 then
return 'No errors found'
else
local ret = {'Found the following errors:'}
for i, msg in ipairs(self.errors) do
ret[#ret + 1] = string.format('* <strong class="error">%s</strong>', msg)
end
return table.concat(ret, '\n')
end
end,
}
end

local function loadData(logger)
-- Load the data table, logging any errors in the process.

-- Check whether the data module can be successfully loaded.
local success, data = pcall(mw.loadData, DATA_MODULE)
if not success then
logger:addError('%s could not be parsed by mw.loadData; check for [[mw:LUAREF#mw.loadData|invalid data]]', DATA_MODULE)
return nil
end

-- Check that the data table is a table.
if type(data) ~= 'table' then
logger:addError('%s returned a %s; table expected', DATA_MODULE, type(data))
end

return data
end

local function checkDataStructure(logger, data)
-- Checks the structure of individual entries.
for dataIndex, subtable in ipairs(data) do
-- Check that subtables are tables.
if type(subtable) ~= 'table' then
logger:addError('Data entry #%d is not a table', dataIndex)
end

-- Check that we have a name for the entry.
if type(subtable.name) ~= 'string' then
logger:addError('Data entry #%d does not have a name field', dataIndex)
elseif subtable.name == '' then
logger:addError('Data entry #%d has a blank name field', dataIndex)
end

-- Check that optional string fields are strings if they are present.
for _, field in ipairs{'description', 'notes'} do
local val = subtable[field]
if val ~= nil and type(val) ~= 'string' then
logger:addEntryTypeError(dataIndex, field, type(val), 'string or nil')
end
end

-- Check that the reason is valid if it is present.
if subtable.reason ~= nil then
if type(subtable.reason) ~= 'string' then
logger:addEntryTypeError(
dataIndex,
'reason',
type(subtable.reason),
'string or nil'
)
elseif not mSensitiveIPs.isValidSensitivityReason(subtable.reason) then
logger:addError(
"The reason field in data entry #%d was invalid (should be '%s')",
dataIndex,
mw.text.listToText(
mSensitiveIPs.getSensitivityReasons,
"', '",
"', or '"
)
)
end
end

-- Check IP range tables.
for i, field in ipairs{'ipv4Ranges', 'ipv6Ranges'} do
local ranges = subtable[field]
if ranges ~= nil then
if type(ranges) ~= 'table' then
logger:addEntryTypeError(dataIndex, field, type(ranges), 'table or nil')
else
for j, range in ipairs(ranges) do
if type(range) ~= 'string' then
logger:addError(
'Range #%d in the %s field of entry #%d was type %s (expected string)',
j, field, type(range)
)
elseif range == '' then
logger:addError(
'Range #%d in the %s field of entry #%d was a blank string',
j, field
)
end
end
end
end
end
end
end

function p.main()
local logger = makeErrorLogger()
local data = loadData(logger)
if logger:hasErrors() then
return logger:makeReport()
end
checkDataStructure(logger, data)
return logger:makeReport()
end

return p