Method test_telemetry_data_points

tests/test_telemetry.py:31–80

(self)

                         os.environ['MSSQL_CLI_TELEMETRY_OPTOUT'].lower() != 'true',
                         "Only works when telemetry opt-out not set to true.")
    def test_telemetry_data_points(self):
        test_telemetry_client = self.build_telemetry_client()
        test_telemetry_client.start()

        try:
            payload = test_telemetry_client.conclude(
                service_endpoint_uri='https://vortex.data.microsoft.com/collect/v1/validate',
                separate_process=False)
            self.assertIsNotNone(payload, 'Payload was empty.')
        except HTTPError:
            self.fail('Recevied HTTP Error when validating payload against vortex.')

        payload = json.loads(payload.replace("'", '"'))

        expected_data_model_properties = [
            'Reserved.ChannelUsed',
            'Reserved.SequenceNumber',
            'Reserved.EventId',
            'Reserved.SessionId',
            'Reserved.TimeSinceSessionStart',
            'Reserved.DataModel.Source',
            'Reserved.DataModel.EntitySchemaVersion',
            'Reserved.DataModel.Severity',
            'Reserved.DataModel.CorrelationId',
            'Context.Default.SQLTools.ExeName',
            'Context.Default.SQLTools.ExeVersion',
            'Context.Default.SQLTools.MacAddressHash',
            'Context.Default.SQLTools.OS.Type',
            'Context.Default.SQLTools.OS.Version',
            'Context.Default.SQLTools.IsDocker',
            'Context.Default.SQLTools.User.Id',
            'Context.Default.SQLTools.User.IsMicrosoftInternal',
            'Context.Default.SQLTools.User.IsOptedIn',
            'Context.Default.SQLTools.ShellType',
            'Context.Default.SQLTools.EnvironmentVariables',
            'Context.Default.SQLTools.Locale',
            'Context.Default.SQLTools.StartTime',
            'Context.Default.SQLTools.EndTime',
            'Context.Default.SQLTools.SessionDuration',
            'Context.Default.SQLTools.PythonVersion',
            'Context.Default.SQLTools.ServerVersion',
            'Context.Default.SQLTools.ServerEdition',
            'Context.Default.SQLTools.ConnectionType',
        ]

        for record in payload:
            properties = record['properties']
            for prop in properties:
                self.assertTrue(prop in expected_data_model_properties,
                                'Additional property detected: {}.'.format(prop))

    def test_telemetry_vortex_format(self):
        test_telemetry_client = self.build_telemetry_client()