Mappings are now defined in a configuration file and fetched dynamically.
Change-Id: I250c22967fc66fc0aca173d4c9d65581d879b5d2
Signed-off-by: Ilia Abashin <abashinos@gmail.com>
--- /dev/null
+{
+ "finders_package": "discover.link_finders",
+ "base_finder": "FindLinks",
+ "link_finders": [
+ "FindLinksForInstanceVnics",
+ "FindLinksForOteps",
+ "FindLinksForPnics",
+ "FindLinksForVconnectors",
+ "FindLinksForVedges",
+ "FindLinksForVserviceVnics"
+ ]
+}
\ No newline at end of file
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
import time
-
from functools import partial
from discover.events.event_base import EventBase, EventResult
from discover.fetchers.api.api_access import ApiAccess
from discover.fetchers.api.api_fetch_regions import ApiFetchRegions
from discover.fetchers.cli.cli_fetch_host_vservice import CliFetchHostVservice
-from discover.find_links_for_vservice_vnics import FindLinksForVserviceVnics
+from discover.link_finders.find_links_for_vservice_vnics import \
+ FindLinksForVserviceVnics
from discover.scanner import Scanner
from utils.util import decode_router_id, encode_router_id
from discover.events.event_base import EventBase, EventResult
from discover.fetchers.api.api_fetch_host_instances import ApiFetchHostInstances
from discover.fetchers.cli.cli_fetch_instance_vnics import CliFetchInstanceVnics
-from discover.fetchers.cli.cli_fetch_instance_vnics_vpp import CliFetchInstanceVnicsVpp
+from discover.fetchers.cli.cli_fetch_instance_vnics_vpp import \
+ CliFetchInstanceVnicsVpp
from discover.fetchers.cli.cli_fetch_vservice_vnics import CliFetchVserviceVnics
-from discover.find_links_for_instance_vnics import FindLinksForInstanceVnics
-from discover.find_links_for_vedges import FindLinksForVedges
+from discover.link_finders.find_links_for_instance_vnics import \
+ FindLinksForInstanceVnics
+from discover.link_finders.find_links_for_vedges import FindLinksForVedges
from discover.scanner import Scanner
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
import datetime
-
from functools import partial
from discover.events.event_base import EventBase, EventResult
from discover.events.event_port_add import EventPortAdd
from discover.events.event_subnet_add import EventSubnetAdd
from discover.fetchers.cli.cli_fetch_host_vservice import CliFetchHostVservice
-from discover.find_links_for_vservice_vnics import FindLinksForVserviceVnics
+from discover.link_finders.find_links_for_vservice_vnics import \
+ FindLinksForVserviceVnics
from discover.scanner import Scanner
from utils.util import decode_router_id, encode_router_id
from discover.events.event_port_delete import EventPortDelete
from discover.events.event_router_add import EventRouterAdd
from discover.fetchers.cli.cli_fetch_host_vservice import CliFetchHostVservice
-from discover.find_links_for_vservice_vnics import FindLinksForVserviceVnics
+from discover.link_finders.find_links_for_vservice_vnics import FindLinksForVserviceVnics
from discover.scanner import Scanner
from utils.util import encode_router_id
from discover.fetchers.api.api_fetch_port import ApiFetchPort
from discover.fetchers.api.api_fetch_regions import ApiFetchRegions
from discover.fetchers.db.db_fetch_port import DbFetchPort
-from discover.find_links_for_pnics import FindLinksForPnics
-from discover.find_links_for_vservice_vnics import FindLinksForVserviceVnics
+from discover.link_finders.find_links_for_pnics import FindLinksForPnics
+from discover.link_finders.find_links_for_vservice_vnics import \
+ FindLinksForVserviceVnics
from discover.scanner import Scanner
from discover.fetchers.api.api_access import ApiAccess
from discover.fetchers.api.api_fetch_regions import ApiFetchRegions
from discover.fetchers.db.db_fetch_port import DbFetchPort
-from discover.find_links_for_vservice_vnics import FindLinksForVserviceVnics
+from discover.link_finders.find_links_for_vservice_vnics import FindLinksForVserviceVnics
from discover.scanner import Scanner
# which accompanies this distribution, and is available at #
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
-from discover.find_links import FindLinks
+from discover.link_finders.find_links import FindLinks
class FindLinksForInstanceVnics(FindLinks):
# which accompanies this distribution, and is available at #
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
-from discover.find_links import FindLinks
+from discover.link_finders.find_links import FindLinks
class FindLinksForOteps(FindLinks):
###############################################################################
import re
-from discover.find_links import FindLinks
+from discover.link_finders.find_links import FindLinks
from utils.util import decode_aci_dn
# which accompanies this distribution, and is available at #
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
-from discover.find_links import FindLinks
+from discover.link_finders.find_links import FindLinks
class FindLinksForVconnectors(FindLinks):
# which accompanies this distribution, and is available at #
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
-from discover.find_links import FindLinks
+from discover.link_finders.find_links import FindLinks
class FindLinksForVedges(FindLinks):
# which accompanies this distribution, and is available at #
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
-from discover.find_links import FindLinks
+from discover.link_finders.find_links import FindLinks
class FindLinksForVserviceVnics(FindLinks):
--- /dev/null
+from utils.metadata_parser import MetadataParser
+from utils.util import ClassResolver
+
+
+class FindLinksMetadataParser(MetadataParser):
+
+ FINDERS_FILE = "link_finders.json"
+
+ FINDERS_PACKAGE = "finders_package"
+ BASE_FINDER = "base_finder"
+ LINK_FINDERS = "link_finders"
+
+ def __init__(self):
+ super().__init__()
+ self.finders_package = None
+ self.base_finder = None
+ self.link_finders = []
+
+ def validate_link_finder(self, finder_class):
+ try:
+ module_name = ClassResolver.get_module_file_by_class_name(finder_class)
+ instance = ClassResolver\
+ .get_instance_of_class(package_name=self.finders_package,
+ module_name=module_name,
+ class_name=finder_class)
+ except ValueError:
+ instance = None
+
+ if instance:
+ self.link_finders.append(instance)
+ else:
+ self.add_error('Failed to import link finder class "{}"'
+ .format(finder_class))
+
+ def validate_metadata(self, metadata: dict):
+ super().validate_metadata(metadata)
+ self.finders_package = metadata[self.FINDERS_PACKAGE]
+ self.base_finder = metadata[self.BASE_FINDER]
+ base_finder_module = ClassResolver\
+ .get_module_file_by_class_name(self.base_finder)
+
+ base_finder_class = ClassResolver.get_class_name_by_module(
+ ".".join((self.finders_package, base_finder_module)))
+
+ if not base_finder_class:
+ self.add_error("Couldn't find base link finder class")
+ return
+
+ for link_finder in metadata[self.LINK_FINDERS]:
+ self.validate_link_finder(finder_class=link_finder)
+ metadata[self.LINK_FINDERS] = self.link_finders
+
+ return len(self.errors) == 0
+
+ def get_required_fields(self) -> list:
+ return [self.FINDERS_PACKAGE, self.BASE_FINDER, self.LINK_FINDERS]
+
# base class for scanners
import json
-import queue
import os
+import queue
import traceback
from discover.clique_finder import CliqueFinder
from discover.configuration import Configuration
from discover.fetcher import Fetcher
-from discover.find_links_for_instance_vnics import FindLinksForInstanceVnics
-from discover.find_links_for_oteps import FindLinksForOteps
-from discover.find_links_for_pnics import FindLinksForPnics
-from discover.find_links_for_vconnectors import FindLinksForVconnectors
-from discover.find_links_for_vedges import FindLinksForVedges
-from discover.find_links_for_vservice_vnics import FindLinksForVserviceVnics
+from discover.link_finders.find_links_metadata_parser import \
+ FindLinksMetadataParser
from discover.scan_error import ScanError
from discover.scan_metadata_parser import ScanMetadataParser
from utils.inventory_mgr import InventoryMgr
self.inv = InventoryMgr()
self.scanners_package = None
self.scanners = {}
- self.load_metadata()
+ self.link_finders = []
+ self.load_scanners_metadata()
+ self.load_link_finders_metadata()
def scan(self, scanner_type, obj, id_field="id",
limit_to_child_id=None, limit_to_child_type=None):
def scan_links(self):
self.log.info("scanning for links")
- fetchers_implementing_add_links = [
- FindLinksForPnics(),
- FindLinksForInstanceVnics(),
- FindLinksForVserviceVnics(),
- FindLinksForVconnectors(),
- FindLinksForVedges(),
- FindLinksForOteps()
- ]
- for fetcher in fetchers_implementing_add_links:
+ for fetcher in self.link_finders:
fetcher.set_env(self.get_env())
fetcher.add_links()
if not ret:
self.found_errors[self.get_env()] = True
- def load_metadata(self):
+ def load_scanners_metadata(self):
parser = ScanMetadataParser(self.inv)
conf = self.config.get_env_config()
scanners_file = os.path.join(conf.get('app_path', '/etc/calipso'),
self.scanners_package = metadata[ScanMetadataParser.SCANNERS_PACKAGE]
self.scanners = metadata[ScanMetadataParser.SCANNERS]
+ def load_link_finders_metadata(self):
+ parser = FindLinksMetadataParser()
+ conf = self.config.get_env_config()
+ finders_file = os.path.join(conf.get('app_path', '/etc/calipso'),
+ 'config',
+ FindLinksMetadataParser.FINDERS_FILE)
+ metadata = parser.parse_metadata_file(finders_file)
+ self.link_finders = metadata[FindLinksMetadataParser.LINK_FINDERS]
+
def get_scanner_package(self):
return self.scanners_package
# which accompanies this distribution, and is available at #
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
-from unittest.mock import MagicMock, patch
+from unittest.mock import patch
from discover.events.event_port_add import EventPortAdd
-from discover.fetchers.api.api_fetch_host_instances import ApiFetchHostInstances
-from discover.fetchers.cli.cli_fetch_instance_vnics import CliFetchInstanceVnics
-from discover.find_links_for_instance_vnics import FindLinksForInstanceVnics
-from discover.find_links_for_vedges import FindLinksForVedges
-from discover.scanner import Scanner
from test.event_based_scan.test_data.event_payload_port_add import \
EVENT_PAYLOAD_PORT_INSTANCE_ADD, NETWORK_DOC, \
INSTANCE_DOC, INSTANCES_ROOT, VNIC_DOCS, INSTANCE_DOCS, PORTS_FOLDER, \
# which accompanies this distribution, and is available at #
# http://www.apache.org/licenses/LICENSE-2.0 #
###############################################################################
-from unittest.mock import MagicMock, patch
+from unittest.mock import patch
from discover.events.event_subnet_add import EventSubnetAdd
from discover.fetchers.api.api_access import ApiAccess
-from discover.find_links_for_pnics import FindLinksForPnics
-from discover.find_links_for_vservice_vnics import FindLinksForVserviceVnics
from test.event_based_scan.test_data.event_payload_subnet_add import \
EVENT_PAYLOAD_SUBNET_ADD, \
EVENT_PAYLOAD_REGION, NETWORK_DOC, HOST_DOC, PORT_DOC
deploy_monitoring_setup_count)
def prepare_scan_mocks(self):
- self.load_metadata = Scanner.load_metadata
+ self.load_link_finders_metadata = Scanner.load_scanners_metadata
+ self.load_scanners_metadata = Scanner.load_scanners_metadata
self.scan = Scanner.scan
self.scan_links = Scanner.scan_links
self.scan_cliques = Scanner.scan_cliques
self.deploy_monitoring_setup = Scanner.deploy_monitoring_setup
- Scanner.load_metadata = MagicMock()
+ Scanner.load_link_finders_metadata = MagicMock()
+ Scanner.load_scanners_metadata = MagicMock()
Scanner.scan = MagicMock()
Scanner.scan_links = MagicMock()
Scanner.scan_cliques = MagicMock()
Scanner.deploy_monitoring_setup = MagicMock()
def reset_methods(self):
- Scanner.load_metadata = self.load_metadata
+ Scanner.load_link_finders_metadata = self.load_link_finders_metadata
+ Scanner.load_scanners_metadata = self.load_scanners_metadata
Scanner.scan = self.scan
Scanner.scan_links = self.scan_links
Scanner.scan_cliques = self.scan_cliques
Code Review / calipso.git / commitdiff