test_templated_pa_components.py

import unittest

from fds.analyticsapi.engines.api.templated_pa_components_api import TemplatedPAComponentsApi
from fds.analyticsapi.engines.api.unlinked_pa_templates_api import UnlinkedPATemplatesApi
from fds.analyticsapi.engines.model.templated_pa_component_parameters import TemplatedPAComponentParameters
from fds.analyticsapi.engines.model.templated_pa_component_parameters_root import TemplatedPAComponentParametersRoot
from fds.analyticsapi.engines.model.pa_component_data import PAComponentData
from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters
from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier
from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup
from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn
from fds.analyticsapi.engines.model.templated_pa_component_summary import TemplatedPAComponentSummary
from fds.analyticsapi.engines.model.templated_pa_component import TemplatedPAComponent
from fds.analyticsapi.engines.model.templated_pa_component_root import TemplatedPAComponentRoot
from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot
from fds.analyticsapi.engines.model.templated_pa_component_post_summary import TemplatedPAComponentPostSummary
from fds.analyticsapi.engines.model.templated_pa_component_update_parameters import TemplatedPAComponentUpdateParameters
from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot
from fds.analyticsapi.engines.model.unlinked_pa_template_parameters import UnlinkedPATemplateParameters
from fds.analyticsapi.engines.model.unlinked_pa_template_parameters_root import UnlinkedPATemplateParametersRoot
from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes


from common_functions import CommonFunctions

parent_template_id = ""

class TestTemplatedPaComponents(unittest.TestCase):
    def setUp(self):
        self.templated_pa_components_api = TemplatedPAComponentsApi(CommonFunctions.build_api_client())
        self.unlinked_pa_templates_api = UnlinkedPATemplatesApi(CommonFunctions.build_api_client())

    def test_a_create_templated_pa_component(self):
        global parent_template_id

        # create unlinked template
        unlinked_pa_template_parameters = UnlinkedPATemplateParameters(
            directory="Personal:SDKTests/DoNotModify/UnlinkedPATemplates/",
            template_type_id="996E90B981AEE83F14029ED3D309FB3F03EC6E2ACC7FD42C22CBD5D279502CFD",
            description="This is an unlinked PA template that only returns security level data",
            accounts = [
                PAIdentifier(
                    id = "SPN:SP50",
                    holdingsmode = "B&H"),
                PAIdentifier(
                    id = "MSCI_USA:984000",
                    holdingsmode = "B&H")],
            benchmarks = [
                PAIdentifier(
                    id = "SPN:SP50",
                    holdingsmode = "B&H"),
                PAIdentifier(
                    id = "DJGX:AMERICAS",
                    holdingsmode = "B&H")],
            columns = [
                PACalculationColumn(
                    id = "BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0",
                    statistics = ["eb9d6d91416e4224bacadc261787e56f"])],
            dates = PADateParameters(
                startdate = "20200101",
                enddate = "20201215",
                frequency = "Monthly"),
            groups = [
                PACalculationGroup(id = "5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA")],
            currencyisocode = "USD",
            componentdetail = "GROUPS",
            content = TemplateContentTypes(
                mandatory = ["accounts", "benchmarks"],
                optional = ["groups", "columns", "currencyisocode", "componentdetail"],
                locked = ["dates"])
        )

        unlinked_pa_template_parameters_root = UnlinkedPATemplateParametersRoot(
            data = unlinked_pa_template_parameters
        )

        templates = self.unlinked_pa_templates_api.create_unlinked_pa_templates(
            unlinked_pa_template_parameters_root = unlinked_pa_template_parameters_root)

        # create templated component
        parent_template_id = templates[0].data['id']

        templated_pa_component_parameters = TemplatedPAComponentParameters(
            directory="Personal:SDKTests/DoNotModify/TemplatedPAComponents/",
            parent_template_id=parent_template_id,
            description="This is a templated PA component",
            component_data = PAComponentData(
                accounts = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "MSCI_USA:984000",
                        holdingsmode = "B&H")],
                benchmarks = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "DJGX:AMERICAS",
                        holdingsmode = "B&H")],
                columns = [
                    PACalculationColumn(
                        id = "BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0",
                        statistics = ["eb9d6d91416e4224bacadc261787e56f"])],
                groups = [
                    PACalculationGroup(id = "5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA")],
                currencyisocode = "USD",
                componentdetail = "GROUPS"
            )
        )

        templated_pa_component_parameters_root = TemplatedPAComponentParametersRoot(
            data = templated_pa_component_parameters
        )

        response = self.templated_pa_components_api.create_templated_pa_components(
            templated_pa_component_parameters_root = templated_pa_component_parameters_root)

        firstcomponent = response[0].data['id']
        self.assertEqual(response[1], 201, "Response should be 201 - Success")
        self.assertEqual(type(response[0].data), TemplatedPAComponentPostSummary, "Response should be of TemplatedPAComponentPostSummary type.")
        self.assertEqual(type(response[0].data['id']),
            str, "Response should be of String type.")
        self.assertGreater(len(response[0].data['id']), 0, "Response result should not be an empty list.")

        # delete templated PA component
        response = self.templated_pa_components_api.delete_templated_pa_components(
            id = firstcomponent
        )

    def test_b_update_templated_pa_component(self):
        global parent_template_id

        templated_pa_component_parameters = TemplatedPAComponentParameters(
            directory="Personal:SDKTests/DoNotModify/TemplatedPAComponents/",
            parent_template_id=parent_template_id,
            description="This is a templated PA component",
            component_data = PAComponentData(
                accounts = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "MSCI_USA:984000",
                        holdingsmode = "B&H")],
                benchmarks = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "DJGX:AMERICAS",
                        holdingsmode = "B&H")],
                columns = [
                    PACalculationColumn(
                        id = "BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0",
                        statistics = ["eb9d6d91416e4224bacadc261787e56f"])],
                groups = [
                    PACalculationGroup(id = "5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA")],
                currencyisocode = "USD",
                componentdetail = "GROUPS"
            )
        )

        templated_pa_component_parameters_root = TemplatedPAComponentParametersRoot(
            data = templated_pa_component_parameters
        )

        components = self.templated_pa_components_api.create_templated_pa_components(
            templated_pa_component_parameters_root = templated_pa_component_parameters_root)

        component_id = components[0].data['id']

        # update templated PA component
        templated_pa_component_update_parameters = TemplatedPAComponentUpdateParameters(
            parent_template_id = parent_template_id,
            description = "This is an updated templated PA component",
            component_data = PAComponentData(
                accounts = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "MSCI_USA:984000",
                        holdingsmode = "B&H")],
                benchmarks = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "DJGX:AMERICAS",
                        holdingsmode = "B&H")],
                columns = [
                    PACalculationColumn(
                        id = "BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0",
                        statistics = ["eb9d6d91416e4224bacadc261787e56f"])],
                groups = [
                    PACalculationGroup(id = "5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA")],
                currencyisocode = "USD",
                componentdetail = "GROUPS"
            )
        )

        templated_pa_component_update_parameters_root = TemplatedPAComponentUpdateParametersRoot (
            data = templated_pa_component_update_parameters
        )

        response = self.templated_pa_components_api.update_templated_pa_components(
            id = component_id, templated_pa_component_update_parameters_root=templated_pa_component_update_parameters_root
        )

        self.assertEqual(response[1], 200, "Response should be 200 - Success")
        self.assertEqual(type(response[0].data), TemplatedPAComponentPostSummary, "Response should be of TemplatedPAComponentPostSummary type.")
        self.assertEqual(type(response[0].data['id']),
            str, "Response should be of String type.")
        self.assertGreater(len(response[0].data['id']), 0, "Response result should not be an empty list.")

        # delete templated PA component
        response = self.templated_pa_components_api.delete_templated_pa_components(
            id = component_id
        )

    def test_c_delete_templated_pa_component(self):
        global parent_template_id

        templated_pa_component_parameters = TemplatedPAComponentParameters(
            directory="Personal:SDKTests/DoNotModify/TemplatedPAComponents/",
            parent_template_id=parent_template_id,
            description="This is a templated PA component",
            component_data = PAComponentData(
                accounts = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "MSCI_USA:984000",
                        holdingsmode = "B&H")],
                benchmarks = [
                    PAIdentifier(
                        id = "SPN:SP50",
                        holdingsmode = "B&H"),
                    PAIdentifier(
                        id = "DJGX:AMERICAS",
                        holdingsmode = "B&H")],
                columns = [
                    PACalculationColumn(
                        id = "BD1720474AB8A80BDD79777F5B9CA594F4151C0554E30F9C916BA73BFAFC1FE0",
                        statistics = ["eb9d6d91416e4224bacadc261787e56f"])],
                groups = [
                    PACalculationGroup(id = "5BCFFD17598FAEBD88EB4934EFB5FEF53849867D607ECEF232CD42D3369BBBCA")],
                currencyisocode = "USD",
                componentdetail = "GROUPS"
            )
        )

        templated_pa_component_parameters_root = TemplatedPAComponentParametersRoot(
            data = templated_pa_component_parameters
        )

        components = self.templated_pa_components_api.create_templated_pa_components(
            templated_pa_component_parameters_root = templated_pa_component_parameters_root)

        component_id = components[0].data['id']

        # delete templated PA component
        response = self.templated_pa_components_api.delete_templated_pa_components(
            id = component_id
        )

        self.assertEqual(response[1], 204, "Response should be 204 - Success")

        # delete unlinked template
        response = self.unlinked_pa_templates_api.delete_unlinked_pa_templates(
            id = parent_template_id
        )

    def test_d_get_templated_pa_component_by_id(self):
        templates = self.templated_pa_components_api.get_templated_pa_components_in_path( 
            directory = "Personal:SDKTests/DoNotModify/TemplatedPAComponents/"
        )
        template_id = list(templates[0].data.keys())[0]

        response = self.templated_pa_components_api.get_templated_pa_component_by_id(
            id = template_id
        )
        
        self.assertEqual(response[1], 200, "Response should be 200 - Success")
        self.assertEqual(type(response[0]), TemplatedPAComponentRoot, "Response should be of TemplatedPAComponentSummaryRoot type.")
        self.assertEqual(type(response[0].data),
            TemplatedPAComponent, "Response should be of LinkedPATemplate type.")

    def test_e__get_templated_pa_components_in_path(self):
        response = self.templated_pa_components_api.get_templated_pa_components_in_path(
            directory = "Personal:SDKTests/DoNotModify/TemplatedPAComponents/"
        )
        firsttemplate = list(response[0].data.keys())[0]
        
        self.assertEqual(response[1], 200, "Response should be 200 - Success")
        self.assertEqual(type(response[0].data), dict, "Response should be of Dictionary type.")
        self.assertEqual(type(response[0].data[firsttemplate]),
            TemplatedPAComponentSummary, "Response should be of TemplatedPAComponentSummary type.")
        self.assertGreater(len(response[0].data), 0, "Response result should not be an empty list.")

if __name__ == '__main__':
    unittest.main()