def populate_teams(self):
"""
Populate team details
"""
pyduty = PagerDuty(os.getenv('PAGERDUTY_KEY'))
try:
for teams in pyduty.get_teams():
for team in teams:
team_, created = Team.objects.get_or_create(
name=team['name'],
team_id=team['id'],
summary=team['summary'],
)
if created:
logger.info(f"{team['name']} has been created")
if settings.INITIAL_INCIDENT_LOOKBACK is not None:
# When the team bootstrap occurs query the past X days for incidents
Team.objects.filter(id=team_.id).update(
last_checked=team_.last_checked - timedelta(
days=int(settings.INITIAL_INCIDENT_LOOKBACK)))
except RequestFailure as err:
logger.error(f'Failed to query PagerDuty: {err}')
return False
return True
def test_query_failure(self, mock_session, mock_request):
"""
Test failing to query PagerDuty
"""
mock_request.json.return_value = {
"error": {
"message": "Your account is expired and cannot use the API.",
"code": 2012
}
}
mock_status = PropertyMock(return_value=401)
type(mock_session).status_code = mock_status
mock_session.send.return_value = mock_session
mock_session.return_value = mock_session
pyduty = PagerDuty('abc123')
team = pyduty.get_teams()
self.assertRaises(RequestFailure, next, team)
mock_request.assert_called_once_with(
headers={
'Accept': 'application/vnd.pagerduty+json;version=2',
'Authorization': 'Token token=abc123'
},
method='GET',
params={
'offset': 0
},
url='https://api.pagerduty.com/teams'
)
def test_get_teams(self, mock_query_resp):
"""
Test getting a single pagination of teams
"""
mock_query_resp.return_value = {
"teams": [
{
"id": "PQ9K7I8",
"type": "team",
"summary": "Engineering",
"self": "https://api.pagerduty.com/teams/PQ9K7I8",
"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
"name": "Engineering",
"description": "All engineering"
}
],
"limit": 25,
"offset": 0,
"total": None,
"more": False
}
pyduty = PagerDuty('abc123')
team = pyduty.get_teams()
self.assertTrue(isinstance(team, types.GeneratorType))
next(team)
mock_query_resp.assert_called_once_with(
endpoint='teams', method='GET', payload={'offset': 0}
)
def test_query(self, mock_session, mock_request):
"""
Test making HTTPS queries to PagerDuty
"""
mock_request.json.return_value = {}
mock_status = PropertyMock(return_value=200)
type(mock_session).status_code = mock_status
mock_session.send.return_value = mock_session
mock_session.return_value = mock_session
pyduty = PagerDuty('abc123')
team = pyduty.get_teams()
next(team)
mock_request.assert_called_once_with(
headers={
'Accept': 'application/vnd.pagerduty+json;version=2',
'Authorization': 'Token token=abc123'
},
method='GET',
params={
'offset': 0
},
url='https://api.pagerduty.com/teams'
)
def test_get_incidents_pagination(self, mock_query_resp):
"""
Test getting a paginated response of incidents
"""
mock_query_resp.side_effect = [
{
"incidents": [
{
"id": "PT4KHLK",
"type": "incident",
"summary": "[#1234] The server is on fire.",
"incident_number": 1234,
"status": "resolved",
"title": "The server is on fire.",
"incident_key": "baf7cf21b1da41b4b0221008339ff357",
"urgency": "high"
}
],
"limit": 25,
"offset": 0,
"total": None,
"more": True
},
{
"incidents": [
{
"id": "PT4KHLK",
"type": "incident",
"summary": "[#1234] The server is on fire.",
"incident_number": 1234,
"status": "resolved",
"title": "The server is on fire.",
"incident_key": "baf7cf21b1da41b4b0221008339ff357",
"urgency": "high"
}
],
"limit": 25,
"offset": 0,
"total": None,
"more": False
}
]
pyduty = PagerDuty('abc123')
incidents = pyduty.get_incidents(
'ABCXYZ',
since=dateutil.parser.parse('2019-01-01T06:42:09.668417+00:00'),
until=dateutil.parser.parse('2019-01-01T06:52:09.668417+00:00')
)
self.assertTrue(isinstance(incidents, types.GeneratorType))
# Skip the two pagination pages
next(incidents)
next(incidents)
self.assertRaises(StopIteration, next, incidents)
def test_get_teams_pagination(self, mock_query_resp):
"""
Test getting a paginated response of teams
"""
mock_query_resp.side_effect = [
{
"teams": [
{
"id": "PQ9K7I8",
"type": "team",
"summary": "Engineering",
"self": "https://api.pagerduty.com/teams/PQ9K7I8",
"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
"name": "Engineering",
"description": "All engineering"
}
],
"limit": 25,
"offset": 0,
"total": None,
"more": True
},
{
"teams": [
{
"id": "PQ9K7I8",
"type": "team",
"summary": "Engineering",
"self": "https://api.pagerduty.com/teams/PQ9K7I8",
"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
"name": "Engineering",
"description": "All engineering"
}
],
"limit": 25,
"offset": 0,
"total": None,
"more": False
},
]
pyduty = PagerDuty('abc123')
team = pyduty.get_teams()
self.assertTrue(isinstance(team, types.GeneratorType))
# Skip the two pagination pages
next(team)
next(team)
self.assertRaises(StopIteration, next, team)
def test_get_incidents(self, mock_query_resp):
"""
Test getting a single pagination of incidents
"""
mock_query_resp.return_value = {
"incidents": [
{
"id": "PT4KHLK",
"type": "incident",
"summary": "[#1234] The server is on fire.",
"incident_number": 1234,
"status": "resolved",
"title": "The server is on fire.",
"incident_key": "baf7cf21b1da41b4b0221008339ff357",
"urgency": "high"
}
],
"limit": 25,
"offset": 0,
"total": None,
"more": False
}
pyduty = PagerDuty('abc123')
incidents = pyduty.get_incidents(
'ABCXYZ',
since=dateutil.parser.parse('2019-01-01T06:42:09.668417+00:00'),
until=dateutil.parser.parse('2019-01-01T06:52:09.668417+00:00')
)
self.assertTrue(isinstance(incidents, types.GeneratorType))
next(incidents)
mock_query_resp.assert_called_once_with(
endpoint='incidents', method='GET',
payload={
'team_ids[]': 'ABCXYZ',
'time_zone': 'UTC',
'since': '2019-01-01T06:42:09.668417+00:00',
'until': '2019-01-01T06:52:09.668417+00:00',
'offset': 0
}
)
def _update_incident(self, incident_id):
"""
Check the status of a ticket and update the status
"""
pyduty = PagerDuty(os.getenv('PAGERDUTY_KEY'))
incident = Incidents.objects.get(id=incident_id)
resp = pyduty.get_incident(incident_id=incident.incident_id)
if resp['status'] != incident.status:
logger.info(
f'Updated incident {incident.incident_id} with the new status of {resp["status"]}'
)
incident.status = resp['status']
incident.save()
return True
def _populate_alerts(self, team_id, since, until):
"""
Populate team alerts
:param team: PagerDuty Team ID
:param since:
:param until:
:return: (bool) successful
"""
pyduty = PagerDuty(os.getenv('PAGERDUTY_KEY'))
team = Team.objects.get(id=team_id)
try:
for incidents in pyduty.get_incidents(
team_id=team.team_id,
since=dateutil.parser.parse(since),
until=dateutil.parser.parse(until)):
for incident in incidents:
_, created = Incidents.objects.get_or_create(
title=incident.get('title', 'No title'),
description=incident.get('description', 'No description'),
summary=incident.get('summary', 'No summary'),
status=incident.get('status', 'No status'),
created_at=incident['created_at'],
incident_id=incident['id'],
urgency=incident['urgency'],
team=team,
)
if created:
logger.info(f"{incident['id']} has been created")
except RequestFailure as err:
logger.error(f'Failed to query PagerDuty: {err}')
return False
team.save()
return True
def test_get_incident(self, mock_query_resp):
"""
Test getting a single incident
"""
mock_query_resp.return_value = {
"incident": {
"id": "PT4KHLK",
"type": "incident",
"summary": "[#1234] The server is on fire.",
"incident_number": 1234,
"status": "resolved",
"title": "The server is on fire.",
},
"urgency": "high"
}
pyduty = PagerDuty('abc123')
pyduty.get_incident('ABCXYZ')
mock_query_resp.assert_called_once_with(
endpoint='incidents/ABCXYZ', method='GET'
)
def test_get_schedule(self, mock_query_resp):
"""
Test getting a specific schedule
"""
mock_query_resp.return_value = {}
pyduty = PagerDuty('abc123')
pyduty.get_schedule(
'ABC123',
dateutil.parser.parse('2019-01-01T06:42:09.668417+00:00'),
dateutil.parser.parse('2019-01-01T06:52:09.668417+00:00')
)
mock_query_resp.assert_called_once_with(
endpoint='schedules/ABC123',
method='GET',
payload={
'id': 'ABC123',
'time_zone': 'UTC',
'since': '2019-01-01T06:42:09.668417+00:00',
'until': '2019-01-01T06:52:09.668417+00:00'
}
)
def test_get_schedules(self, mock_query_resp):
"""
Test getting a specific teams list of schedules
"""
mock_query_resp.return_value = {
"schedules": [
{
"id": "PI7DH85",
"type": "schedule",
"summary": "Daily Engineering Rotation",
"self": "https://api.pagerduty.com/schedules/PI7DH85",
"html_url": "https://subdomain.pagerduty.com/schedules/PI7DH85",
"name": "Daily Engineering Rotation",
"time_zone": "America/New_York",
"description": "Rotation schedule for engineering",
}
],
"limit": 100,
"offset": 0,
"total": None,
"more": False
}
pyduty = PagerDuty('abc123')
schedules = pyduty.get_schedules('TEAMID')
self.assertTrue(isinstance(schedules, types.GeneratorType))
# Skip the two pagination pages
next(schedules)
self.assertRaises(StopIteration, next, schedules)
mock_query_resp.assert_called_once_with(
endpoint='schedules', method='GET', payload={'offset': 25, 'team_ids[]': 'TEAMID'}
)