1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""Tool to validate artifact definitions."""
from __future__ import print_function
from __future__ import unicode_literals
import argparse
import logging
import os
import sys
from artifacts import definitions
from artifacts import errors
from artifacts import reader
from artifacts import registry
class ArtifactDefinitionsValidator(object):
"""Class to define an artifact definitions validator."""
LEGACY_PATH = os.path.join('definitions', 'legacy.yaml')
def __init__(self):
"""Initializes the artifact definitions validator object."""
super(ArtifactDefinitionsValidator, self).__init__()
self._artifact_registry = registry.ArtifactDefinitionsRegistry()
self._artifact_registry_key_paths = set()
def _HasDuplicateRegistryKeyPaths(self, filename, artifact_definition,
source):
"""Checks if Registry key paths are not already defined by other artifacts.
Note that at the moment this function will only find exact duplicate
Registry key paths.
Args:
filename: the filename of the artifacts definition file.
artifact_definition: the artifact definition (instance of
ArtifactDefinition).
source: the source definition (instance of SourceType).
Returns:
A boolean indicating the Registry key paths defined by the source type
are used in other artifacts.
"""
result = False
intersection = self._artifact_registry_key_paths.intersection(set(
source.keys))
if intersection:
duplicate_key_paths = u'\n'.join(intersection)
logging.warning((u'Artifact definition: {0} in file: {1} has duplicate '
u'Registry key paths:\n{2}').format(
artifact_definition.name, filename,
duplicate_key_paths))
result = True
self._artifact_registry_key_paths.update(source.keys)
return result
def CheckFile(self, filename):
"""Validates the artifacts definition in a specific file.
Args:
filename: the filename of the artifacts definition file.
Returns:
A boolean indicating the file contains valid artifacts definitions.
"""
result = True
artifact_reader = reader.YamlArtifactsReader()
try:
for artifact_definition in artifact_reader.ReadFile(filename):
try:
self._artifact_registry.RegisterDefinition(artifact_definition)
except KeyError:
logging.warning(
u'Duplicate artifact definition: {0} in file: {1}'.format(
artifact_definition.name, filename))
result = False
for source in artifact_definition.sources:
if source.type_indicator in (
definitions.TYPE_INDICATOR_WINDOWS_REGISTRY_KEY):
# Exempt the legacy file from duplicate checking because it has
# duplicates intentionally.
if (filename != self.LEGACY_PATH and
self._HasDuplicateRegistryKeyPaths(filename,
artifact_definition,
source)):
result = False
except errors.FormatError as exception:
logging.warning(u'Unable to validate file: {0} with error: {1}'.format(
filename, exception))
result = False
return result
def GetUndefinedArtifacts(self):
"""Retrieves the names of undefined artifacts used by artifact groups.
Returns:
A set of the undefined artifacts names.
"""
return self._artifact_registry.GetUndefinedArtifacts()
def Main():
"""The main program function.
Returns:
A boolean containing True if successful or False if not.
"""
args_parser = argparse.ArgumentParser(
description=('Validates an artifact definitions file.'))
args_parser.add_argument('filename', nargs='?', action='store',
metavar='artifacts.yaml', default=None,
help=('path of the file that contains the artifact '
'definitions.'))
options = args_parser.parse_args()
if not options.filename:
print('Source value is missing.')
print('')
args_parser.print_help()
print('')
return False
if not os.path.isfile(options.filename):
print('No such file: {0}'.format(options.filename))
print('')
return False
print('Validating: {0}'.format(options.filename))
validator = ArtifactDefinitionsValidator()
if not validator.CheckFile(options.filename):
print('FAILURE')
return False
print('SUCCESS')
return True
if __name__ == '__main__':
if not Main():
sys.exit(1)
else:
sys.exit(0)
|
