Dell removed the ordernumbers, Moved over to DOQL for purchases

CHANGELOG.md

@@ -1,3 +1,17 @@
+## 25.04.2019
+- ordernumbers: Added shipdate option in warranty.cfg for dell systems. This due to dell removing the orderno from the api output
+- if an existing registration exists, make use of that order number to compare/register
+- ordernumbers: instead of vendor set common as default. Though might want to set descrete as default, or skipdate. Device42 doesn't show more than 1000 lines in the webbgui overview of an order.
+- Defaulting to Dell API production url
+- Debug output shows proper serials, not including the \_epoch
+- Using DOQL for getting existing purchases to speed up script execution
+- added boolean for DOQL and DEBUG (debug existed, but now also works in starter.py)
+- bugfix: corrected hasher comparison
+- bugfix: corrected working of the booleans (true/false actually works now)
+- Dell API: increased api retry to 60secs
+- bugfix: If no purchaselines are returned the script will stop (can be forced to go on with boolean forcedupdate in warranty.cfg). Reason for doing: noticed sometimes the query didn't give purchaselines, just ordernumbers. In that case the script would continue and make double entries.
+
+
 ## 30.04.2017
 - service type field has been extended in version 13.1.0.
 - Added an option to force updating the line items. Needed as the Service Type does not get updated otherwise as the contents of the field can't be checked via the api to see if it needs a change.

Files/shared.py

@@ -14,6 +14,7 @@
 if os.path.isfile(CONFIGFILE):
     CC.readfp(open(CONFIGFILE, "r"))
     DEBUG = CC.getboolean('other', 'debug')
+    DOQL = CC.getboolean('other', 'doql')
     RETRY = int(CC.get('other', 'retry'))
     ORDER_NO_TYPE = CC.get('other', 'order_no_type')
 else:
@@ -44,6 +45,8 @@ def get_config(self, source):
             res = self.__get_ibm_cfg()
         elif source == 'lenovo':
             res = self.__get_lenovo_cfg()
+        elif source == 'other':
+            res = self.__get_other_cfg()
         else:
             print '\n[!] Error. Unknown source "%s".\n\tExiting...\n' % source
             sys.exit()
@@ -125,6 +128,15 @@ def __get_lenovo_cfg(self):
             'url2': lenovo_url2
         }
 
+    def __get_other_cfg(self):
+        # lenovo -------------------------------------------
+        debug = self.cc.getboolean('other', 'debug')
+        doql = self.cc.getboolean('other', 'doql')
+        return {
+            'debug': debug,
+            'doql': doql
+        }
+
 
 class Device42rest:
     def __init__(self, params):
@@ -192,6 +204,24 @@ def get_purchases(self):
         response = self.get_data(api_path)
         return response
 
+    def fetcher(self, url):
+        headers = {
+            'Authorization': 'Basic ' + base64.b64encode(self.username + ':' + self.password),
+            'Content-Type': 'application/x-www-form-urlencoded'
+        }
+
+        r = requests.get(url, headers=headers, verify=False)
+        msg = 'Status code: %s' % str(r.status_code)
+        return r.text
+
+    def get_doqldata(self, query):
+        if DEBUG:
+            print '\n[!] DOQL: ', query
+        api_path = '/services/data/v1.0/query/?query='
+        url = self.url+'/services/data/v1.0/query/?query='+query
+        response = self.fetcher(url)
+        return response
+
     def get_lifecycle(self):
         if DEBUG:
             print '\n[!] Fetching life cycle purchase events from Device42'

Files/warranty.cfg.example

@@ -15,7 +15,10 @@ forcedupdate = False
 [dell]
 # set api_key as provided by Dell
 api_key =
-url = https://sandbox.api.dell.com/support/assetinfo/v4/getassetwarranty
+# production
+url = https://api.dell.com/support/assetinfo/v4/getassetwarranty
+# sandbox
+#url = https://sandbox.api.dell.com/support/assetinfo/v4/getassetwarranty
 
 [hp]
 # set api_key as provided by HP
@@ -34,10 +37,13 @@ url2 = http://support.lenovo.com/us/en/products
 [other]
 # print verbose info to STDOUT
 debug = True
+# use DOQL instead
+doql = True
 # number of retries for HTTP connections
 retry = 3
 # order number type can be one of:
-#	1. vendor   - order number is returned from vendor ( only for Dell )
+#	1. vendor   - order number is returned from vendor ( used to work for Dell. API doesn't return them anymore )
 #	2. common   - order number is randomly generated and same for all purchases
-#	3. descrete - order number is randomly generated and uniqe for every purchase
-order_no_type = vendor
+#	3. descrete - order number is randomly generated and unique for every purchase
+#	4. shipdate - order number is based on the shipping date of the equipment ( only for Dell )
+order_no_type = common

Files/warranty_dell.py

@@ -30,11 +30,6 @@ def run_warranty_check(self, inline_serials, retry=True):
         global full_serials
         full_serials = {}
 
-        if self.debug:
-            print '\t[+] Checking warranty info for "%s"' % inline_serials
-        timeout = 10
-
-
         # making sure the warranty also gets updated if the serial has been changed by decom lifecycle process
         incoming_serials = inline_serials.split(',')
         inline_serials = []
@@ -52,16 +47,24 @@ def run_warranty_check(self, inline_serials, retry=True):
             inline_serials.append(d42_serial)
         inline_serials = ','.join(inline_serials)
 
+        if self.debug:
+            print '\t[+] Checking warranty info for "%s"' % inline_serials
+        timeout = 30
+
         payload = {'id': inline_serials, 'apikey': self.api_key, 'accept': 'Application/json'}
 
         try:
             resp = requests.get(self.url, params=payload, verify=True, timeout=timeout)
             msg = 'Status code: %s' % str(resp.status_code)
-            if str(resp.status_code) == '401' or str(resp.status_code) == '404':
+            if str(resp.status_code) != '200':
                 print '\t[!] HTTP error. Message was: %s' % msg
-                print '\t[!] waiting for 30 seconds to let the api server calm down'
-                # suspecting blockage due to to many api calls. Put in a pause of 30 seconds and go on
-                time.sleep(30)
+                if str(resp.status_code) == '401':
+                    print '\t[!] API call unauthorized. Wrong/expired key? Wrong endpoint?'
+                if str(resp.status_code) == '404':
+                    print '\t[!] 404: Information not found?'
+                # suspecting blockage due to to many api calls. Put in a pause and go on
+                print '\t[!] waiting for 60 seconds to let the api server calm down'
+                time.sleep(60)
                 if retry:
                     print '\n[!] Retry'
                     self.run_warranty_check(inline_serials, False)
@@ -74,7 +77,7 @@ def run_warranty_check(self, inline_serials, retry=True):
             self.error_msg(e)
             return None
 
-    def process_result(self, result, purchases):
+    def process_result(self, result, purchases, ordernos):
         global full_serials
         data = {}
 
@@ -98,9 +101,24 @@ def process_result(self, result, purchases):
                         order_no = asset['OrderNumber']
                     elif self.order_no == 'common':
                         order_no = self.common
+                    elif self.order_no == 'shipdate':
+                        if self.debug:
+                            print '[!] WORKING ON: \n',item
+                        try:
+                            #some systems have no shipping date mentioned
+                            #or the service_tag is incorrect. Confirm via iDrac and support.dell.com
+                            order_no = asset['ShipDate'].split('T')[0]
+                        except:
+                            order_no = '0000-00-00'
                     else:
                         order_no = self.generate_random_order_no()
 
+                    try:
+                        #If an existing registration with ordernumber exists, make use of that one.
+                        order_no = ordernos[asset['ServiceTag'].lower()]
+                    except Exception as e:
+                        print e
+
                     serial = asset['ServiceTag']
                     customernumber = asset['CustomerNumber']
                     country = asset['CountryLookupCode']
@@ -171,13 +189,14 @@ def process_result(self, result, purchases):
                         data.update({'line_end_date': end_date})
 
                         # update or duplicate? Compare warranty dates by serial, contract_id, start date and end date
-                        hasher = serial + line_contract_id + start_date + end_date
+                        hasher = serial.lower() + line_contract_id + start_date + end_date
                         try:
                             d_purchase_id, d_order_no, d_line_no, d_contractid, d_start, d_end, forcedupdate = purchases[hasher]
 
                             if forcedupdate:
-                                data['purchase_id'] = d_purchase_id
-                                data.pop('order_no')
+                                data.update({'order_no': start_date})
+                                data.update({'purchase_id': d_purchase_id})
+                                data.update({'line_no': d_line_no})
                                 raise KeyError
 
                             # check for duplicate state

Files/warranty_hp.py

@@ -231,7 +231,7 @@ def process_result(self, result, purchases):
                 pass
 
             # update or duplicate? Compare warranty dates by serial, contract_id and end date
-            hasher = serial + start_date + end_date
+            hasher = serial.lower() + start_date + end_date
 
             try:
                 d_purchase_id, d_order_no, d_line_no, d_contractid, d_start, d_end, forcedupdate = purchases[hasher]

Files/warranty_ibm_lenovo.py

@@ -152,7 +152,7 @@ def process_result(self, result, purchases):
                     pass
 
                 # update or duplicate? Compare warranty dates by serial, contract_id and end date
-                hasher = serial.split('.')[0] + start_date + end_date
+                hasher = serial.lower() + start_date + end_date
 
                 try:
                     d_purchase_id, d_order_no, d_line_no, d_contractid, d_start, d_end, forcedupdate = purchases[hasher]

README.md

@@ -20,9 +20,13 @@ In order for this script to check warranty status of the device, the device must
 - If either hardware model or serial # is missing, warranty status won't be checked for device.
 - IBM script points to warranty info not related to the SKU, serial given
 
+## Known issues
+- Leave the DOQL boolean to True. The regular API doesn't built up the dictionary for compensating Dell removing the ordernumbers. If on false you could get double registrations
+
 ## Change Log
 - Please check `CHANGELOG.md`
 
+
 ## Usage
 - Set required parameters in warranty.cfg file and run warranty_dell.py script:
 
@@ -37,8 +41,9 @@ In order for this script to check warranty status of the device, the device must
 - Add the path to your environment : "%PythonFolder%\Scripts"
 - Run `pip install requests`
 - Run `python starter.py`
+- Or just download python 2.7 from https://www.python.org/ as pip is included
 
 ## Compatibility
 * requests module required
 * Script runs on Linux and Windows
-* Python 2.7
+* Python 2.7

starter.py

@@ -58,6 +58,7 @@ def get_vendor_api(name):
 
 
 def loader(name, api, d42):
+    global ordernos
 
     # Locate the devices involved, based on the hardware models found, add offset with recursion
     offset = 0
@@ -92,7 +93,7 @@ def loader(name, api, d42):
                 result = vendor_api.run_warranty_check(inline_serials)
 
                 if result is not None:
-                    api.process_result(result, purchases)
+                    api.process_result(result, purchases, ordernos)
 
             offset += 50
         else:
@@ -105,6 +106,7 @@ def loader(name, api, d42):
     cfg = Config()
     d42_cfg = cfg.get_config('d42')
     discover = cfg.get_config('discover')
+    other = cfg.get_config('other')
 
     # init
     d42_params = {
@@ -114,30 +116,72 @@ def loader(name, api, d42):
     }
     d42_rest = Device42rest(d42_params)
 
+    forcedupdate = discover['forcedupdate']
+    DEBUG        = other['debug']
+    DOQL         = other['doql']
+
     # get purchases data from Device42
-    orders = d42_rest.get_purchases()
     purchases = {}
-
-    if orders and 'purchases' in orders:
-        for order in orders['purchases']:
-            if 'line_items' in order:
-                purchase_id = order.get('purchase_id')
-                order_no = order.get('order_no')
-
-                for line_item in order['line_items']:
-                    line_no = line_item.get('line_no')
-                    devices = line_item.get('devices')
-                    contractid = line_item.get('line_notes')
-                    start = line_item.get('line_start_date')
-                    end = line_item.get('line_end_date')
-
-                    if start and end and devices:
-                        for device in devices:
-                            if 'serial_no' in device:
-                                serial = device['serial_no']
-                                hasher = serial + contractid + start + end
-                                if hasher not in purchases:
-                                    purchases[hasher] = [purchase_id, order_no, line_no, contractid, start, end, discover['forcedupdate']]
+    global ordernos
+    ordernos  = {}
+
+    if DOQL:
+        orders = d42_rest.get_doqldata('select purchaselineitem_pk,order_no,line_no,contract_id,contract_type_name,service_type_name,li.start_date,li.end_date,LIDEV.device_name,DEV.serial_no,li.cc_code from view_purchase_v1 PUR LEFT JOIN view_purchaselineitem_v1 LI ON PUR.purchase_pk=LI.purchase_fk LEFT JOIN view_purchaselineitems_to_devices_v1 LIDEV on (LI.purchaselineitem_pk=LIDEV.purchaselineitem_fk) LEFT JOIN view_device_v1 DEV on (LIDEV.device_fk=DEV.device_pk)' )
+        #if DEBUG:
+        #    print orders
+        orders = orders.splitlines()
+        for order in orders:
+            if order.split(',')[1]:
+                if not order.split(',')[2]:
+                    # some occurances happened that only the ordernu was returned.
+                    # As a result there is no information to compare with, so double registrations were made.
+                    # some alerting needs to be put in place for this.
+                    if forcedupdate:
+                        if DEBUG: print '[!] no purchaselines found. Continue is forced. This could result in double entries!'
+                    else:
+                        if DEBUG: print '[!] No purchaselines!\n\tHalting script to prevent double registrations.'
+                        sys.exit()
+                #Check if there is a lineitem for the order. If so register the lineitem in the array
+                purchase_id     = order.split(',')[0]
+                order_no        = order.split(',')[1]
+                line_no         = order.split(',')[2]
+                contractid      = order.split(',')[3]
+                contracttype    = order.split(',')[4]
+                servicetype     = order.split(',')[5]
+                start           = order.split(',')[6]
+                end             = order.split(',')[7]
+                devices         = order.split(',')[8]
+                serial          = order.split(',')[9]
+
+                # Build dictionary to compensate for Dell removing order_nos from the api output
+                ordernos[serial.split('_')[0].lower()] = order_no
+
+                if start and end and devices and contractid and serial:
+                    hasher = serial.split('_')[0].lower() + contractid + start + end
+                    if hasher not in purchases:
+                        purchases[hasher] = [purchase_id, order_no, line_no, contractid, start, end, discover['forcedupdate']]
+    else:
+        orders = d42_rest.get_purchases()
+        if orders and 'purchases' in orders:
+            for order in orders['purchases']:
+                if 'line_items' in order:
+                    purchase_id = order.get('purchase_id')
+                    order_no = order.get('order_no')
+
+                    for line_item in order['line_items']:
+                        line_no = line_item.get('line_no')
+                        devices = line_item.get('devices')
+                        contractid = line_item.get('line_notes')
+                        start = line_item.get('line_start_date')
+                        end = line_item.get('line_end_date')
+
+                        if start and end and devices and contractid:
+                            for device in devices:
+                                if 'serial_no' in device:
+                                    serial = device['serial_no']
+                                    hasher = serial + contractid + start + end
+                                    if hasher not in purchases:
+                                        purchases[hasher] = [purchase_id, order_no, line_no, contractid, start, end, discover['forcedupdate']]
 
     APPS_ROW = []
     if discover['dell']: