Skip to content

Commit

Permalink
PR review updates, allow reason arg and filename filter arg
Browse files Browse the repository at this point in the history
  • Loading branch information
@amy-gb
amy-gb committed Jul 1, 2024
1 parent b574c5c commit c87e252
Show file tree
Hide file tree
Showing 2 changed files with 159 additions and 72 deletions.
90 changes: 79 additions & 11 deletions tests/standalone_plugins/test_deprecate_vts.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,41 @@ def test_parse_args(self):
testfile = "testfile.nasl"
output_path = "attic/"
input_path = "nasl/common"
oid_mapping_file = "oid_file.py"
reason = "notus"

args = parse_args(
[
"--file",
str(testfile),
"--output-path",
output_path,
"--oid-mapping-path",
oid_mapping_file,
"--input-path",
input_path,
"--deprecation-reason",
reason,
]
)
self.assertEqual(args.file, Path(testfile))
self.assertEqual(args.output_path, output_path)
self.assertEqual(args.oid_mapping_path, oid_mapping_file)
self.assertEqual(args.deprecation_reason, reason)
self.assertEqual(args.input_path, input_path)

def test_parse_args_invali_reason(self):
output_path = "attic/"
input_path = "nasl/common"
reason = "foo"
with self.assertRaises(SystemExit):
parse_args(
[
"--output-path",
output_path,
"--input-path",
input_path,
"--deprecation-reason",
reason,
]
)


NASL_CONTENT = (
'...if(description)\n{\n script_oid("1.3.6.1.4.1.25623.1.0.910673");'
Expand Down Expand Up @@ -77,13 +93,16 @@ def test_deprecate(self):
content=NASL_CONTENT,
)
]
deprecate(out_dir, to_deprecate)
deprecate(out_dir, to_deprecate, "notus")

result = testfile2.read_text(encoding="utf8")
self.assertNotIn(result, "script_mandatory_keys")
self.assertNotIn(result, "script_dependencies")
self.assertNotIn(result, 'include("revisions-lib.inc");')
assert "This VT has been deprecated." in result
assert (
"Note: This VT has been deprecated and replaced by "
"a Notus scanner based one."
) in result

def test_deprecate_kb_item(self):
with TemporaryDirectory() as out_dir, TemporaryDirectory() as in_dir:
Expand All @@ -97,15 +116,17 @@ def test_deprecate_kb_item(self):
content=NASL_CONTENT_KB,
)
]
deprecate(out_dir, to_deprecate)
deprecate(out_dir, to_deprecate, "notus")
self.assertLogs(
"Unable to deprecate testfile1.nasl. There are still KB keys remaining."
"Unable to deprecate testfile1.nasl. There are still KB keys "
"remaining."
)

def test_get_summary(self):
result = get_summary(NASL_CONTENT)
expected = (
"The remote host is missing an update for the 'gd'\n package(s) announced "
"The remote host is missing an update for the 'gd'\n package(s) "
"announced "
"via the RHSA-2020:5443-01 advisory."
)
self.assertEqual(result, expected)
Expand All @@ -114,7 +135,7 @@ def test_finalize_content(self):
result = finalize_content(NASL_CONTENT)
expected = (
'...if(description)\n{\n script_oid("1.3.6.1.4.1.25623.1.0.910673");\n '
'script_version("2024-03-12T14:15:13+0000");\n script_name("RedHat: Security Advisory for gd (RHSA-2020:5443-01)");\n script_family("Red Hat Local Security Checks");\n script_dependencies("gather-package-list.nasl");\n script_mandatory_keys("ssh/login/rhel", "ssh/login/rpms", re:"ssh/login/release=RHENT_7");\n\n script_xref(name:"RHSA", value:"2020:5443-01");\n script_xref(name:"URL", value:"https://www.redhat.com/archives/rhsa-announce/2020-December/msg00044.html");\n\n script_tag(name:"summary", value:"The remote host is missing an update for the \'gd\'\n package(s) announced via the RHSA-2020:5443-01 advisory.");\n\n script_tag(name: \'deprecated\', value: TRUE);\n\nexit(0);\n}\n\nexit(66);\n'
'script_version("2024-03-12T14:15:13+0000");\n script_name("RedHat: Security Advisory for gd (RHSA-2020:5443-01)");\n script_family("Red Hat Local Security Checks");\n script_dependencies("gather-package-list.nasl");\n script_mandatory_keys("ssh/login/rhel", "ssh/login/rpms", re:"ssh/login/release=RHENT_7");\n\n script_xref(name:"RHSA", value:"2020:5443-01");\n script_xref(name:"URL", value:"https://www.redhat.com/archives/rhsa-announce/2020-December/msg00044.html");\n\n script_tag(name:"summary", value:"The remote host is missing an update for the \'gd\'\n package(s) announced via the RHSA-2020:5443-01 advisory.");\n\n script_tag(name:"deprecated", value:TRUE);\n\nexit(0);\n}\n\nexit(66);\n'
)
self.assertEqual(result, expected)

Expand All @@ -124,7 +145,7 @@ def test_update_summary_no_oid_match(self):
full_path=Path("dir/testfile.nasl"),
content=NASL_CONTENT,
)
result = update_summary(file)
result = update_summary(file, "notus")
self.assertIn("This VT has been deprecated", result)

def test_get_files_dir(self):
Expand All @@ -143,6 +164,34 @@ def test_get_files_dir(self):

self.assertEqual(result, expected)

def test_get_files_dir_filtered_in(self):
with TemporaryDirectory() as in_dir:
testfile1 = in_dir / "gb_rhsa_2021_8383_8383.nasl"
testfile1.write_text(NASL_CONTENT, encoding="utf8")
testfile2 = in_dir / "gb_rhsa_2020_8383_8383.nasl"
testfile2.write_text(NASL_CONTENT, encoding="utf8")

result = get_files(dir_path=in_dir, filename_prefix="gb_rhsa_2021")
expected = [
DeprecatedFile(
name="gb_rhsa_2021_8383_8383.nasl",
full_path=in_dir / "gb_rhsa_2021_8383_8383.nasl",
content=NASL_CONTENT,
)
]

self.assertEqual(result, expected)

def test_get_files_dir_filtered_out(self):
with TemporaryDirectory() as in_dir:
testfile1 = in_dir / "gb_rhsa_2021_8383_8383.nasl"
testfile1.write_text(NASL_CONTENT, encoding="utf8")

result = get_files(dir_path=in_dir, filename_prefix="gb_rhsa_2020")
expected = []

self.assertEqual(result, expected)

def test_get_files_single(self):
with TemporaryDirectory() as in_dir:
testfile1 = in_dir / "gb_rhsa_2021_8383_8383.nasl"
Expand All @@ -158,3 +207,22 @@ def test_get_files_single(self):
]

self.assertEqual(result, expected)

def test_get_files_single_filtered_in(self):
with TemporaryDirectory() as in_dir:
testfile1 = in_dir / "gb_rhsa_2021_8383_8383.nasl"
testfile2 = in_dir / "gb_rhsa_2022_8484.nasl"

testfile1.write_text(NASL_CONTENT, encoding="utf8")
testfile2.write_text(NASL_CONTENT, encoding="utf8")

result = get_files(file=testfile1, filename_prefix="gb_rhsa_2021")
expected = [
DeprecatedFile(
name="gb_rhsa_2021_8383_8383.nasl",
full_path=in_dir / "gb_rhsa_2021_8383_8383.nasl",
content=NASL_CONTENT,
)
]

self.assertEqual(result, expected)
Loading

0 comments on commit c87e252

Please sign in to comment.