[ENHANCEMENT] Adding the new feature to remove stale entries based on the # of days

- Adding the new feature to remove stale entries based on the # of days
- Changelog updated
- Code updated, added some docstring, and removed some commented stuff
- Pytest for the inventory menu updated
- Version updated

Author: waldirio

conf/conf.py

@@ -10,7 +10,7 @@
 
 
 # Current Version
-CURRENT_VERSION = "1.10.11"
+CURRENT_VERSION = "1.11.12"
 
 #  Some file references
 
@@ -26,6 +26,8 @@
 VULNERABILITY_SYSTEMS_FILE = (p / "vulnerability_systems.csv").resolve()
 ADVISOR_FILE = (p / "advisor_systems.csv").resolve()
 
+STALE_FILE = (p / "stale_systems_based_on_date.json").resolve()
+
 # TS Info
 INV_JSON_FILE = (p / "inventory.json").resolve()
 SW_JSON_FILE = (p / "swatch.json").resolve()

docs/changelog.rst

@@ -1,6 +1,24 @@
 Changelog
 ---------
 
+
+**v1.11.12 - 01/26/2023**
+
+- [ENHANCEMENT] Adding the new feature to remove stale entries based on the # of days - [`issue 24`_]
+- [FIX] Fixing the syspurpose issue - [`issue 168`_]
+
+.. _issue 168: https://github.com/C-RH-C/crhc-cli/issues/168
+.. _issue 24: https://github.com/C-RH-C/crhc-cli/issues/24
+
+
+
+**v1.10.11 - 08/16/2022**
+
+- [FIX] Ordering the inventory output, avoiding wrong information - [`issue 163`_]
+.. _issue 163: https://github.com/C-RH-C/crhc-cli/issues/163
+
+
+
 **v1.10.10 - 03/25/2022**
 
 - [ENHANCEMENT] Fixing linters warnings - [`issue 97`_]
@@ -38,6 +56,7 @@ Changelog
 .. _issue 134: https://github.com/C-RH-C/crhc-cli/pull/134
 
 
+
 **v1.8.8 - 11/06/2021**
 
 - [ENHANCEMENT] Docs updated and Feature page created - [`issue 125`_]
@@ -63,6 +82,7 @@ Changelog
 .. _issue 102: https://github.com/C-RH-C/crhc-cli/issues/102
 
 
+
 **v1.7.7 - 10/16/2021**
 
 - [ENHANCEMENT] issue_summary_created - [`issue 76`_]
@@ -78,6 +98,7 @@ Changelog
 .. _issue 88: https://github.com/C-RH-C/crhc-cli/issues/88
 
 
+
 **v1.6.6 - 10/12/2021**
 
 - [ENHANCEMENT] help redesigned and some tests added - [`issue 82`_]
@@ -86,12 +107,15 @@ Changelog
 .. _issue 82: https://github.com/C-RH-C/crhc-cli/issues/82
 
 
+
 **v1.5.6 - 10/03/2021**
 
 - [FIX] Fixed the correct # of pages and servers - [`issue 78`_]
 
 .. _issue 78: https://github.com/C-RH-C/crhc-cli/issues/78
 
+
+
 **v1.5.5 - 10/02/2021**
 
 - [ENHANCEMENT] Stale fields added - [`issue 68`_]
@@ -111,12 +135,14 @@ Changelog
 .. _issue 59: https://github.com/C-RH-C/crhc-cli/issues/59
 
 
+
 **v1.4.4 - 09/23/2021**
 
 - [FIX] Fixing the error caused by an empty conf file
 - [FIX] fixing a minor typo that is causing keyerror issue for the inventory list - short version
 
 
+
 **v1.4.3 - 09/11/2021**
 
 - [ENHANCEMENT] Adding the troubleshooting feature - dump json files for inventory
@@ -145,6 +171,7 @@ Changelog
 - [FEATURE] Authentication using Token
 
 
+
 **v1.1.0 08/25/2021**
 
 - [RFE] remove the sort keys in the JSON output
@@ -154,6 +181,7 @@ Changelog
 - [FEATURE] Way to query the API endpoint directly
 
 
+
 **v1.0.0 - 08/07/2021**
 
  - Initial idea and first piece of code! :)

execution/execution.py

@@ -13,6 +13,8 @@
 import os
 import time
 import requests
+import datetime
+from report import report
 from credential import token
 from conf import conf
 
@@ -34,6 +36,21 @@ def connection_request(url):
     return response
 
 
+def connection_request_delete(url):
+    """
+    Definition responsible to receive the url, call it and send back the
+    response, updating the token whenever necessary.
+    """
+
+    access_token = token.get_token()
+    response = requests.delete(
+        url, headers={"Authorization": "Bearer {}".format(access_token)}
+    )
+
+    return response
+
+
+
 def check_authentication(response=None):
     """
     Check if the current credential is valid and authenticating, if not, will
@@ -182,6 +199,63 @@ def inventory_list_all():
     return inventory_full_detail
 
 
+def inventory_list_all_no_system_profile():
+    """
+    This def will collect all the HBI entries. This call will be pretty quick
+    once we are not consulting the system_profile endpoint, just the host one.
+    """
+
+    url = "https://console.redhat.com/api/inventory/v1/hosts?per_page=1"
+    response = connection_request(url)
+    check_authentication(response)
+
+    # Here we are checking the total number of objects and setting the correct
+    # number of pages based on that.
+    # check_response = divmod(response.json()['total'], 50)
+    # ITEMS_PER_PAGE = 10
+    check_response = divmod(response.json()["total"], conf.ITEMS_PER_PAGE)
+
+    if check_response[1] == 0:
+        num_of_pages = check_response[0] + 1
+    else:
+        num_of_pages = check_response[0] + 2
+
+    list_of_servers = []
+    inventory_full_detail = {"results": "", "total": response.json()["total"]}
+    inventory_full_detail["results"] = list_of_servers
+
+    stage_list = []
+    stage_dic = {"server": stage_list}
+
+    # For debugin purposes
+    # num_of_pages = 2
+
+    for page in range(1, num_of_pages):
+        url = (
+            "https://console.redhat.com/api/inventory/v1/hosts?per_page="
+            + str(conf.ITEMS_PER_PAGE)
+            + "&page="
+            + str(page)
+            + "&order_by=display_name"
+        )
+        response = connection_request(url)
+
+        # debug
+        # print("page # {}".format(page))
+
+        for server in response.json()["results"]:
+
+            try:
+                stage_dic["server"] = server
+            except json.decoder.JSONDecodeError:
+                stage_dic["server"] = {}
+
+            list_of_servers.append(stage_dic)
+            stage_dic = {}
+
+    return inventory_full_detail
+
+
 def inventory_list_search_by_name(fqdn):
     """
     This def will search the HBI entries by keyword
@@ -230,6 +304,73 @@ def inventory_list_search_by_name(fqdn):
     return inventory_full_detail
 
 
+def inventory_remove_stale(num_of_days):
+    """
+    Def responsible to receive the # of days and check
+    all the servers currently in console.redhat.com, check the last
+    update and compare with the current date - num_of_days passed
+    by the customer.
+    """
+
+    print("The file with the server list to be removed will be created here: {}".format(conf.STALE_FILE))
+    # Getting the current date and time
+    current_date = datetime.datetime.now()
+    # Calculating the date to be tested and removed before that
+    date_to_test_and_remove = current_date - datetime.timedelta(days=int(num_of_days))
+
+    print("Inside remove stale, # of days: {}".format(num_of_days))
+    print("Please, wait while checking the information ...")
+    list_server_with_no_system_profile = inventory_list_all_no_system_profile()
+
+    # print("ready to go")
+    stage_lst = []
+
+    for srv in list_server_with_no_system_profile['results']:
+        srv_last_update = srv['server']['updated'].split("T")[0]
+        # To convert from string to format type
+        srv_last_update_time_format = datetime.datetime.strptime(srv_last_update, "%Y-%m-%d")
+        if srv_last_update_time_format < date_to_test_and_remove:
+            stage_lst.append(srv)
+
+    report.json_stale_systems(stage_lst)
+
+    count = len(stage_lst)
+    print("We got {} entries with date equal or less than {}.".format(count, date_to_test_and_remove.strftime("%Y-%m-%d")))
+    print("if you wish, you can open a second terminal and double-check the file {} with the complete list of servers that will be removed, before you proceed.".format(conf.STALE_FILE))
+    opt = input("Would you like to proceed and remove then? (y|Y|n|N): ")
+
+    if (opt == "y") or (opt == "Y"):
+        # print("proceed")
+        inventory_remove_entry(stage_lst)
+    elif (opt == "n") or (opt == "N"):
+        print("Canceling")
+    else:
+        print("Invalid option")
+
+    # print("ready to go")
+
+
+def inventory_remove_entry(srv_to_be_removed):
+    """
+    Def responsible to remove the entry from console.redhat.com
+    """
+    # print("we are here to remove the entries")
+
+    if len(srv_to_be_removed) == 0:
+        print("Nothing to remove")
+        sys.exit()
+
+    for srv in srv_to_be_removed:
+        print("here to check")
+        srv_uuid = srv['server']['id']
+        last_update = srv['server']['updated']
+        # srv_uuid = "1784587a-a502-4b98-97ea-634e92e882e2"
+        url = ("https://console.redhat.com/api/inventory/v1/hosts/" + srv_uuid)
+        print("Removing .: {}, last update at: {}".format(url, last_update))
+        response = connection_request_delete(url)
+        check_authentication(response)
+
+
 def swatch_list():
     """
     This def will collect the first 100 entries from Subscription Watch

help/help_opt.py

@@ -47,6 +47,7 @@ def help_inventory_menu():
     list            List the inventory entries, first 50\n\
     list_all        List all the inventory entries\n\
     display_name    Please, type the FQDN or Partial Hostname\n\
+    remove_stale    Remove all the stale entries based on the # of days\n\
     \n\
 Flags: \n\
     --csv           This will generate the output in CSV format. By default, it will be JSON.\

parse/parse.py

@@ -72,6 +72,27 @@ def inventory_sub_menu():
             # print("Error: {}".format(e))
             ...
 
+        # To print in JSON format
+        try:
+            if (sys.argv[1] == "inventory") and (sys.argv[2] == "remove_stale"):
+                # execution.inventory_list()
+                # response = execution.inventory_list()
+                # print(response)
+                # print(json.dumps(response, indent=4))
+                num_of_days=input("Please, type the # of days with no updates. 0 for today, 1 for yesteday, 2 for 2 days ago ...: ")
+                if num_of_days.isdigit():
+                    pass
+                else:                
+                    print("invalid entry, exiting")
+                    sys.exit()
+                response = execution.inventory_remove_stale(num_of_days)
+                # print("end here")
+                sys.exit()
+        except IndexError as e:
+            # print("Error: {}".format(e))
+            ...
+
+
     # To print in JSON format
     if len(sys.argv) == 4 and (sys.argv[2]) == "display_name":
         try:
@@ -175,6 +196,9 @@ def inventory_sub_menu():
             ...
 
 
+
+
+
 def swatch_sub_menu():
     """
     The Subscription Watch sub menu

report/report.py

@@ -6,6 +6,7 @@
 # from os import write
 import csv
 import os
+import json
 from conf import conf
 
 
@@ -1616,3 +1617,16 @@ def csv_report_advisor(json_obj):
         writer.writerows(report_list)
 
     print("File {} created".format(conf.ADVISOR_FILE))
+
+
+
+def json_stale_systems(stale_srv_list):
+    """
+    Responsible for write down the entries that will be removed. Note,
+    it will be in JSON format.
+    """
+    # print("inside the report")
+    # print(json.dumps(stale_srv_list, indent=4))
+
+    with open(conf.STALE_FILE, "w") as file_obj:
+        file_obj.write(json.dumps(stale_srv_list, indent=4))

tests/test_help.py

@@ -49,6 +49,7 @@ def test_check_inventory_help_menu():
     list            List the inventory entries, first 50\n\
     list_all        List all the inventory entries\n\
     display_name    Please, type the FQDN or Partial Hostname\n\
+    remove_stale    Remove all the stale entries based on the # of days\n\
     \n\
 Flags: \n\
     --csv           This will generate the output in CSV format. By default, it will be JSON.\