Update bash completions for sonic-utilities commands (sonic-net#4163)

What I did
Update the bash completion files for all sonic-utilities commands to make them compatible with the current Click version.

Fixes sonic-net/sonic-buildimage#24594.

How I did it
Use Click's documentation to generate the bash completion script for each command that is packaged from sonic-utilities and uses Click.

How to verify it
Tested in KVM in Trixie image.

admin@vlab-01:~$ sonic-package-manager
install     list        manifests   migrate     repository  reset       show        uninstall   update
admin@vlab-01:~$ sonic-package-manager
install     list        manifests   migrate     repository  reset       show        uninstall   update
admin@vlab-01:~$ sonic-package-manager
install     list        manifests   migrate     repository  reset       show        uninstall   update
admin@vlab-01:~$ spm
install     list        manifests   migrate     repository  reset       show        uninstall   update
admin@vlab-01:~$ spm ^C
admin@vlab-01:~$ show
Display all 105 possibilities? (y or n)
aaa                       buffer_pool               environment               icmp                      macsec                    passw-hardening           runningconfiguration      suppress-fib-pending      vlan
acl                       chassis                   event-counters            interfaces                management_interface      pbh                       serial_console            switch                    vnet
arp                       clock                     fabric                    ip                        mgmt-vrf                  pfc                       services                  switch-hash               vrf
asic-sdk-health-event     copp                      feature                   ipv6                      mirror_session            pfcwd                     sflow                     switch-trimming           vrrp
auto-techsupport          dhcp4relay-counters       fg-nhg                    kdump                     mmu                       platform                  snmpagentaddress          syslog                    vrrp6
auto-techsupport-feature  dhcp6relay_counters       fg-nhg-member             kubernetes                muxcable                  policer                   snmptrap                  system-health             vxlan
banner                    dhcp_relay                fg-nhg-prefix             ldap                      nat                       priority-group            spanning-tree             system-memory             warm_restart
bfd                       dhcp_server               fgnhg                     ldap-server               ndp                       processes                 srv6                      tacacs                    watermark
bgp                       dhcprelay_helper          flowcnt-route             line                      ntp                       queue                     ssh                       techsupport               ztp
bmp                       dns                       flowcnt-trap              lldp                      nvgre-tunnel              radius                    startupconfiguration      uptime
boot                      dropcounters              headroom-pool             logging                   nvgre-tunnel-map          reboot-cause              storm-control             users
buffer                    ecn                       history                   mac                       p4-table                  route-map                 subinterfaces             version
admin@vlab-01:~$ config
aaa                       cbf                       dropcounters              interface_naming_mode     loopback                  nvgre-tunnel-map          reload                    spanning-tree             unique-ip
acl                       chassis                   ecn                       ipv6                      macsec                    override-config-table     replace                   ssh                       vlan
apply-patch               checkpoint                fabric                    kdump                     mclag                     passw-hardening           rollback                  subinterface              vnet
asic-sdk-health-event     clock                     feature                   kubernetes                member                    pbh                       route                     suppress-fib-pending      vrf
auto-techsupport          console                   fg-nhg                    ldap                      mirror_session            pfcwd                     save                      switch-hash               vxlan
auto-techsupport-feature  delete-checkpoint         fg-nhg-member             ldap-server               mmu                       platform                  serial_console            switch-trimming           warm_restart
banner                    dhcp_relay                fg-nhg-prefix             list-checkpoints          muxcable                  portchannel               sflow                     switchport                watermark
bgp                       dhcp_server               flowcnt-route             load                      nat                       qos                       snmp                      synchronous_mode          yang_config_validation
bmp                       dhcpv4_relay              hostname                  load_mgmt_config          ntp                       radius                    snmpagentaddress          syslog                    ztp
buffer                    dns                       interface                 load_minigraph            nvgre-tunnel              rate                      snmptrap                  tacac
Note that these commands don't have a completion script generated, likely because an exception is being raised when just importing that module:

Cannot generate completion for counterpoll.main:cli!
Cannot generate completion for debug.main:cli!
Cannot generate completion for fwutil.main:cli!
Cannot generate completion for psuutil.main:cli!
Cannot generate completion for sfputil.main:cli!
Cannot generate completion for undebug.main:cli!

Signed-off-by: Ramesh Raghupathy <[email protected]>

Author: saiarcot895

azure-pipelines.yml

@@ -185,3 +185,121 @@ stages:
     - publish: '$(System.DefaultWorkingDirectory)/gcu/dist/'
       artifact: gcu_wheels
       displayName: "Publish Python wheels for GCU"
+
+- stage: BuildData
+
+  jobs:
+  - job:
+    displayName: "Build sonic-utilities-data"
+    pool:
+      vmImage: ubuntu-24.04
+
+    container:
+      image: sonicdev-microsoft.azurecr.io:443/sonic-slave-bookworm:$(BUILD_BRANCH)
+
+    steps:
+    - script: |
+        set -ex
+        sudo apt-get update
+        sudo apt-get install -y python3-pip
+        sudo apt-get install -y python3-protobuf
+      displayName: "Install dependencies"
+
+    - script: |
+        sourceBranch=$(Build.SourceBranchName)
+        if [[ "$(Build.Reason)" == "PullRequest" ]];then
+          sourceBranch=$(System.PullRequest.TargetBranch)
+        fi
+        echo "Download artifact branch: $sourceBranch"
+        echo "##vso[task.setvariable variable=sourceBranch]$sourceBranch"
+      displayName: "Get correct artifact downloading branch"
+
+    - task: DownloadPipelineArtifact@2
+      inputs:
+        source: specific
+        project: build
+        pipeline: 142
+        artifact: sonic-buildimage.vs
+        runVersion: 'latestFromBranch'
+        runBranch: 'refs/heads/$(sourceBranch)'
+        patterns: |
+          **/*.deb
+          **/*.whl
+      displayName: "Download artifacts from latest sonic-buildimage build"
+
+    - script: |
+        set -xe
+        sudo apt-get -y purge libnl-3-dev libnl-route-3-dev || true
+        sudo dpkg -i libnl-3-200_*.deb
+        sudo dpkg -i libnl-genl-3-200_*.deb
+        sudo dpkg -i libnl-route-3-200_*.deb
+        sudo dpkg -i libnl-nf-3-200_*.deb
+        sudo dpkg -i libyang_1.0.73_amd64.deb
+        sudo dpkg -i libyang-cpp_1.0.73_amd64.deb
+        sudo dpkg -i python3-yang_1.0.73_amd64.deb
+      workingDirectory: $(Pipeline.Workspace)/target/debs/bookworm/
+      displayName: 'Install Debian dependencies'
+
+    - task: DownloadPipelineArtifact@2
+      inputs:
+        source: specific
+        project: build
+        pipeline: 9
+        artifact: sonic-swss-common-bookworm
+        runVersion: 'latestFromBranch'
+        runBranch: 'refs/heads/$(sourceBranch)'
+      displayName: "Download sonic swss common deb packages"
+
+    - script: |
+        set -xe
+        sudo dpkg -i libswsscommon_1.0.0_amd64.deb
+        sudo dpkg -i python3-swsscommon_1.0.0_amd64.deb
+      workingDirectory: $(Pipeline.Workspace)/
+      displayName: 'Install swss-common dependencies'
+
+    - task: DownloadPipelineArtifact@2
+      inputs:
+        source: specific
+        project: build
+        pipeline: sonic-net.sonic-dash-api
+        artifact: sonic-dash-api
+        runVersion: 'latestFromBranch'
+        runBranch: 'refs/heads/$(BUILD_BRANCH)'
+        path: $(Build.ArtifactStagingDirectory)/download
+        patterns: |
+          libdashapi*.deb
+      displayName: "Download dash api"
+
+    - script: |
+        set -xe
+        sudo apt-get update
+        sudo dpkg -i $(Build.ArtifactStagingDirectory)/download/libdashapi_*.deb
+      workingDirectory: $(Pipeline.Workspace)/
+      displayName: 'Install libdashapi libraries'
+
+    - script: |
+        set -xe
+        sudo pip3 install swsssdk-2.0.1-py3-none-any.whl
+        sudo pip3 install sonic_py_common-1.0-py3-none-any.whl
+        sudo pip3 install sonic_yang_mgmt-1.0-py3-none-any.whl
+        sudo pip3 install sonic_yang_models-1.0-py3-none-any.whl
+        sudo pip3 install sonic_config_engine-1.0-py3-none-any.whl
+        sudo pip3 install sonic_platform_common-1.0-py3-none-any.whl
+      workingDirectory: $(Pipeline.Workspace)/target/python-wheels/bookworm/
+      displayName: 'Install Python dependencies'
+
+    - task: DownloadPipelineArtifact@2
+      inputs:
+        artifact: wheels
+        path: $(Build.ArtifactStagingDirectory)/download
+      displayName: "Download pre-stage built sonic-utilities"
+
+    - script: |
+        sudo pip3 install sonic_utilities-1.2-py3-none-any.whl
+      workingDirectory: $(Build.ArtifactStagingDirectory)/download
+      displayName: 'Install sonic-utilities wheel'
+
+    - script: |
+        cd sonic-utilities-data
+        dpkg-buildpackage -b
+      displayName: 'Build sonic-utilities-data package'

show/main.py

@@ -271,14 +271,17 @@ def is_gearbox_configured():
     Checks whether Gearbox is configured or not
     """
     app_db = SonicV2Connector()
-    app_db.connect(app_db.APPL_DB)
+    try:
+        app_db.connect(app_db.APPL_DB)
 
-    keys = app_db.keys(app_db.APPL_DB, '*')
+        keys = app_db.keys(app_db.APPL_DB, '*')
 
-    # If any _GEARBOX_TABLE:phy:* records present in APPL_DB, then the gearbox is configured
-    if any(re.match(GEARBOX_TABLE_PHY_PATTERN, key) for key in keys):
-        return True
-    else:
+        # If any _GEARBOX_TABLE:phy:* records present in APPL_DB, then the gearbox is configured
+        if any(re.match(GEARBOX_TABLE_PHY_PATTERN, key) for key in keys):
+            return True
+        else:
+            return False
+    except RuntimeError:
         return False
 
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help', '-?'])