Skip to content

Hardware cancel consolidation #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
underscorephil merged 2 commits into from
Apr 20, 2015
Merged

Hardware cancel consolidation #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
769d900
Consolidates hardware canceling logic
sudorandom Apr 14, 2015
ab50844
Fixes trivial linting issues
sudorandom Apr 14, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion SoftLayer/CLI/server/detail.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def cli(env, identifier, passwords, price):
result = utils.NestedDict(result)

table.add_row(['id', result['id']])
table.add_row(['guid', result['globalIdentifier']] or formatting.blank())
table.add_row(['guid', result['globalIdentifier'] or formatting.blank()])
table.add_row(['hostname', result['hostname']])
table.add_row(['domain', result['domain']])
table.add_row(['fqdn', result['fullyQualifiedDomainName']])
Expand Down
47 changes: 9 additions & 38 deletions SoftLayer/managers/hardware.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,51 +47,22 @@ def cancel_hardware(self, hardware_id, reason='unneeded', comment='',
:param string comment: An optional comment to include with the
cancellation.
"""
# Check to see if this is actually a pre-configured server (BMC). They
# require a different cancellation call.
server = self.get_hardware(hardware_id,
mask='id,bareMetalInstanceFlag')

if server.get('bareMetalInstanceFlag'):
return self.cancel_metal(hardware_id, immediate)

# Get cancel reason
reasons = self.get_cancellation_reasons()
cancel_reason = reasons['unneeded']

if reason in reasons:
cancel_reason = reasons[reason]

# Arguments per SLDN:
# attachmentId - Hardware ID
# Reason
# content - Comment about the cancellation
# cancelAssociatedItems
# attachmentType - Only option is HARDWARE
return self.client['Ticket'].createCancelServerTicket(hardware_id,
cancel_reason,
comment,
True,
'HARDWARE')

def cancel_metal(self, hardware_id, immediate=False):
"""Cancels the specified bare metal instance.

:param int id: The ID of the bare metal instance to be cancelled.
:param bool immediate: If true, the bare metal instance will be
cancelled immediately. Otherwise, it will be
scheduled to cancel on the anniversary date.
"""
cancel_reason = reasons.get(reason, reasons['unneeded'])

hw_billing = self.get_hardware(hardware_id,
mask='mask[id, billingItem.id]')
if 'billingItem' not in hw_billing:
raise SoftLayer.SoftLayerError(
"No billing item found for hardware")

billing_id = hw_billing['billingItem']['id']

billing_item = self.client['Billing_Item']

if immediate:
return billing_item.cancelService(id=billing_id)
else:
return billing_item.cancelServiceOnAnniversaryDate(id=billing_id)
return self.client.call('Billing_Item', 'cancelItem',
immediate, False, cancel_reason, comment,
id=billing_id)

def list_hardware(self, tags=None, cpus=None, memory=None, hostname=None,
domain=None, datacenter=None, nic_speed=None,
Expand Down
58 changes: 27 additions & 31 deletions SoftLayer/tests/managers/hardware_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,57 +243,53 @@ def test_place_order(self, create_dict):
self.assert_called_with('SoftLayer_Product_Order', 'placeOrder',
args=({'test': 1, 'verify': 1},))

def test_cancel_metal_immediately(self):

result = self.hardware.cancel_metal(6327, immediate=True)

self.assertEqual(result, True)
self.assert_called_with('SoftLayer_Billing_Item', 'cancelService',
identifier=6327)

def test_cancel_metal_on_anniversary(self):

result = self.hardware.cancel_metal(6327, False)

self.assertEqual(result, True)
self.assert_called_with('SoftLayer_Billing_Item',
'cancelServiceOnAnniversaryDate',
identifier=6327)

def test_cancel_hardware_without_reason(self):
mock = self.set_mock('SoftLayer_Hardware_Server', 'getObject')
mock.return_value = {'id': 987, 'bareMetalInstanceFlag': False}
mock.return_value = {'id': 987, 'billingItem': {'id': 1234}}

result = self.hardware.cancel_hardware(987)

self.assertEqual(result,
fixtures.SoftLayer_Ticket.createCancelServerTicket)
self.assertEqual(result, True)
reasons = self.hardware.get_cancellation_reasons()
args = (987, reasons['unneeded'], '', True, 'HARDWARE')
self.assert_called_with('SoftLayer_Ticket', 'createCancelServerTicket',
args = (False, False, reasons['unneeded'], '')
self.assert_called_with('SoftLayer_Billing_Item', 'cancelItem',
identifier=1234,
args=args)

def test_cancel_hardware_with_reason_and_comment(self):
mock = self.set_mock('SoftLayer_Hardware_Server', 'getObject')
mock.return_value = {'id': 987, 'bareMetalInstanceFlag': False}
mock.return_value = {'id': 987, 'billingItem': {'id': 1234}}

result = self.hardware.cancel_hardware(987, 'sales', 'Test Comment')
result = self.hardware.cancel_hardware(6327,
reason='sales',
comment='Test Comment')

self.assertEqual(result,
fixtures.SoftLayer_Ticket.createCancelServerTicket)
self.assertEqual(result, True)
reasons = self.hardware.get_cancellation_reasons()
args = (987, reasons['sales'], 'Test Comment', True, 'HARDWARE')
self.assert_called_with('SoftLayer_Ticket', 'createCancelServerTicket',
args = (False, False, reasons['sales'], 'Test Comment')
self.assert_called_with('SoftLayer_Billing_Item', 'cancelItem',
identifier=1234,
args=args)

def test_cancel_hardware_on_bmc(self):
def test_cancel_hardware(self):

result = self.hardware.cancel_hardware(6327)

self.assertEqual(result, True)
self.assert_called_with('SoftLayer_Billing_Item',
'cancelServiceOnAnniversaryDate',
identifier=6327)
'cancelItem',
identifier=6327,
args=(False, False, 'No longer needed', ''))

def test_cancel_hardware_no_billing_item(self):
mock = self.set_mock('SoftLayer_Hardware_Server', 'getObject')
mock.return_value = {'id': 987}

ex = self.assertRaises(SoftLayer.SoftLayerError,
self.hardware.cancel_hardware,
6327)
self.assertEqual("No billing item found for hardware",
str(ex))

def test_change_port_speed_public(self):
self.hardware.change_port_speed(2, True, 100)
Expand Down