add null check for empty kube-config in connectedk8s proxy scenario

Author: Bavneet Singh

src/connectedk8s/HISTORY.rst

@@ -3,6 +3,10 @@
 Release History
 ===============
 
+1.10.4
+++++++
+* Fixed the issue where the 'connectedk8s proxy' command would fail if the kubeconfig file was empty.
+
 1.10.3
 ++++++
 * Fixed linting and styling issues, and added type annotations.

src/connectedk8s/azext_connectedk8s/custom.py

@@ -3372,11 +3372,14 @@ def merge_kubernetes_configurations(
                 break
         except (KeyError, TypeError):
             continue
-
-    handle_merge(existing, addition, "clusters", replace)
-    handle_merge(existing, addition, "users", replace)
-    handle_merge(existing, addition, "contexts", replace)
-    existing["current-context"] = addition["current-context"]
+    
+    if existing is None:
+        existing = addition
+    else:
+        handle_merge(existing, addition, "clusters", replace)
+        handle_merge(existing, addition, "users", replace)
+        handle_merge(existing, addition, "contexts", replace)
+        existing["current-context"] = addition["current-context"]
 
     # check that ~/.kube/config is only read- and writable by its owner
     if platform.system() != "Windows":

src/connectedk8s/setup.py

@@ -13,7 +13,7 @@
 # TODO: Confirm this is the right version number you want and it matches your
 # HISTORY.rst entry.
 
-VERSION = "1.10.3"
+VERSION = "1.10.4"
 
 # The full list of classifiers is available at
 # https://pypi.python.org/pypi?%3Aaction=list_classifiers

testing/.gitignore

@@ -0,0 +1,9 @@
+settings.json
+tmp/
+bin/*
+!bin/connectedk8s-1.0.0-py3-none-any.whl
+!bin/k8s_extension-0.3.0-py3-none-any.whl
+!bin/k8s_extension_private-0.1.0-py3-none-any.whl
+!bin/k8s_configuration-1.0.0-py3-none-any.whl
+!bin/connectedk8s-values.yaml
+*.xml

testing/Bootstrap.ps1

@@ -0,0 +1,30 @@
+param (
+    [switch] $SkipInstall,
+    [switch] $CI
+)
+
+# Disable confirm prompt for script
+az config set core.disable_confirm_prompt=true
+
+# Configuring the environment
+$ENVCONFIG = Get-Content -Path $PSScriptRoot/settings.json | ConvertFrom-Json
+
+az account set --subscription $ENVCONFIG.subscriptionId
+
+if (-not (Test-Path -Path $PSScriptRoot/tmp)) {
+    New-Item -ItemType Directory -Path $PSScriptRoot/tmp
+}
+
+az group show --name $envConfig.resourceGroup
+if (!$?) {
+    Write-Host "Resource group does not exist, creating it now in region 'eastus2euap'"
+    az group create --name $envConfig.resourceGroup --location eastus2euap
+
+    if (!$?) {
+        Write-Host "Failed to create Resource Group - exiting!"
+        Exit 1
+    }
+}
+
+
+Copy-Item $HOME/.kube/config -Destination $PSScriptRoot/tmp/KUBECONFIG 

testing/README.md

@@ -0,0 +1,116 @@
+# K8s Partner Extension Test Suite
+
+This repository serves as the integration testing suite for the `k8s-extension` Azure CLI module.
+
+## Testing Requirements
+
+All partners who wish to merge their __Custom Private Preview Release__ (owner: _Partner_) into the __Official Private Preview Release__ are required to author additional integration tests for their extension to ensure that their extension will continue to function correctly as more extensions are added into the __Official Private Preview Release__.
+
+For more information on creating these tests, see [Authoring Tests](docs/test_authoring.md)
+
+## Pre-Requisites
+
+In order to properly test all regression tests within the test suite, you must onboard an AKS cluster which you will use to generate your Azure Arc resource to test the extensions. Ensure that you have a resource group where you can onboard this cluster.
+
+### Required Installations
+
+The following installations are required in your environment for the integration tests to run correctly:
+
+1. [Helm 3](https://helm.sh/docs/intro/install/)
+2. [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
+3. [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
+
+## Setup
+
+### Step 1: Install Pester
+
+This project contains [Pester](https://pester.dev/) test framework commands that are required for the integration tests to run. In an admin powershell terminal, run
+
+```powershell
+Install-Module Pester -Force -SkipPublisherCheck
+Import-Module Pester -PassThru
+```
+
+If you run into issues installing the framework, refer to the [Installation Guide](https://pester.dev/docs/introduction/installation) provided by the Pester docs.
+
+### Step 2: Get Test suite files
+
+You can either clone this repo (preferred option, since you will be adding your tests to this suite) or copy the files in this repo locally. Rest of the instructions here assume your working directory is k8spartner-extension-testing.
+
+### Step 3: Update the `k8s-extension`/`k8s-extension-private` .whl package
+
+This integration test suite references the .whl packages found in the `\bin` directory. After generating your `k8s-extension`/`k8s-extension-private` .whl package, copy your updated package into the `\bin` directory.
+
+### Step 4: Create a `settings.json`
+
+To onboard the AKS and Arc clusters correctly, you will need to create a `settings.json` configuration. Create a new `settings.json` file by copying the contents of the `settings.template.json` into this file. Update the subscription id, resource group, and AKS and Arc cluster name fields with your specific values.
+
+### Step 5: Update the extension version value in `settings.json`
+
+To ensure that the tests point to your `k8s-extension-private` `.whl` package, change the value of the `k8s-extension-private` to match your package versioning in the format (Major.Minor.Patch.Extension). For example, the `k8s_extension_private-0.1.0.openservicemesh_5-py3-none-any.whl` whl package would have extension versions set to
+```json
+{
+    "k8s-extension": "0.1.0",
+    "k8s-extension-private": "0.1.0.openservicemesh_5",
+    "connectedk8s": "0.3.5"
+}
+
+```
+
+_Note: Updates to the `connectedk8s` version and `k8s-extension` version can also be made by adding a different version of the `connectedk8s` and `k8s-extension` whl packages and changing the `connectedk8s` and `k8s-extension` values to match the (Major.Minor.Patch) version format shown above_
+
+### Step 6: Run the Bootstrap Command
+To bootstrap the environment with AKS and Arc clusters, run
+```powershell
+.\Bootstrap.ps1
+```
+This script will provision the AKS and Arc clusters needed to run the integration test suite
+
+## Testing
+
+### Testing All Extension Suites
+To test all extension test suites, you must call `.\Test.ps1` with the `-ExtensionType` parameter set to either `Public` or `Private`. Based on this flag, the test suite will install the extension type specified below
+
+| `-ExtensionType` |  Installs `az extension`             |
+| ---------------- | ---------------------                |
+| `Public`         | `k8s-extension`                      |
+| `Private`        | `k8s-extension-private`              |
+
+For example, when calling
+```bash
+.\Test.ps1 -ExtensionType Public
+```
+the script will install your `k8s-extension` whl package and run the full test suite of `*.Tests.ps1` files included in the `\test\extensions` directory
+
+### Testing Public Extensions Only
+If you only want to run the test cases against public-preview or GA extension test cases, you can use the `-OnlyPublicTests` flag to specify this
+```bash
+.\Test.ps1 -ExtensionType Public -OnlyPublicTests
+```
+
+### Testing Specific Extension Suite
+
+If you only want to run the test script on your specific test file, you can do so by specifying path to your extension test suite in the execution call
+
+```powershell
+.\Test.ps1 -Path <path\to\extensionsuite>
+```
+For example to call the `AzureMonitor.Tests.ps1` test suite, we run
+```powershell
+.\Test.ps1 -ExtensionType Public -Path .\test\extensions\public\AzureMonitor.Tests.ps1
+```
+
+### Skipping Extension Re-Install
+
+By default the `Test.ps1` script will uninstall any old versions of `k8s-extension`/'`k8s-extension-private` and re-install the version specified in `settings.json`. If you do not want this re-installation to occur, you can specify the `-SkipInstall` flag to skip this process.
+
+```powershell
+.\Test.ps1 -ExtensionType Public -SkipInstall
+```
+
+## Cleanup
+To cleanup the AKS and Arc clusters you have provisioned in testing, run
+```powershell
+.\Cleanup.ps1
+```
+This will remove the AKS and Arc clusters as well as the `\tmp` directory that were created by the bootstrapping script.

testing/Test.ps1

@@ -0,0 +1,95 @@
+param (
+    [string] $Path,
+    [switch] $SkipInstall,
+    [switch] $CI,
+    [switch] $ParallelCI,
+    [switch] $OnlyPublicTests,
+
+    [Parameter(Mandatory=$True)]
+    [ValidateSet('connectedk8s')]
+    [string]$Type
+)
+
+# Disable confirm prompt for script
+# Only show errors, don't show warnings
+az config set core.disable_confirm_prompt=true
+az config set core.only_show_errors=true
+
+$ENVCONFIG = Get-Content -Path $PSScriptRoot/settings.json | ConvertFrom-Json
+
+az account set --subscription $ENVCONFIG.subscriptionId
+
+$Env:KUBECONFIG="$PSScriptRoot/tmp/KUBECONFIG"
+$TestFileDirectory="$PSScriptRoot/results"
+
+if (-not (Test-Path -Path $TestFileDirectory)) {
+    New-Item -ItemType Directory -Path $TestFileDirectory
+}
+
+if ($Type -eq 'connectedk8s') {
+    $connectedk8sVersion = $ENVCONFIG.extensionVersion.'connectedk8s'
+    if (!$SkipInstall) {
+        Write-Host "Removing the old connectedk8s extension..."
+        az extension remove -n connectedk8s
+        Write-Host "Installing connectedk8s version $connectedk8sVersion..."
+        az extension add --source ./bin/connectedk8s-$connectedk8sVersion-py2.py3-none-any.whl
+    }
+    $testFilePaths = "$PSScriptRoot/test/configurations"
+}
+
+if ($ParallelCI) {
+    # This runs the tests in parallel during the CI pipline to speed up testing
+
+    Write-Host "Invoking Pester to run tests from '$testFilePath'..."
+    $testFiles = @()
+    foreach ($paths in $testFilePaths) 
+    {
+        $temp = Get-ChildItem $paths
+        $testFiles += $temp
+    }
+    $resultFileNumber = 0
+    foreach ($testFile in $testFiles)
+    {
+        $resultFileNumber++
+        $testName = Split-Path $testFile –leaf
+        Start-Job -ArgumentList $testName, $testFile, $resultFileNumber, $TestFileDirectory -Name $testName -ScriptBlock {
+            param($name, $testFile, $resultFileNumber, $testFileDirectory)
+
+            Write-Host "$testFile to result file #$resultFileNumber"
+            $testResult = Invoke-Pester $testFile -Passthru -Output Detailed
+            $testResult | Export-JUnitReport -Path "$testFileDirectory/$name.xml"
+        }
+    }
+
+    do {
+        Write-Host ">> Still running tests @ $(Get-Date –Format "HH:mm:ss")" –ForegroundColor Blue
+        Get-Job | Where-Object { $_.State -eq "Running" } | Format-Table –AutoSize 
+        Start-Sleep –Seconds 30
+    } while((Get-Job | Where-Object { $_.State -eq "Running" } | Measure-Object).Count -ge 1)
+
+    Get-Job | Wait-Job
+    $failedJobs = Get-Job | Where-Object { -not ($_.State -eq "Completed")}
+    Get-Job | Receive-Job –AutoRemoveJob –Wait –ErrorAction 'Continue'
+
+    if ($failedJobs.Count -gt 0) {
+        Write-Host "Failed Jobs" –ForegroundColor Red
+        $failedJobs
+        throw "One or more tests failed"
+    }
+} elseif ($CI) {
+    if ($Path) {
+        $testFilePath = "$PSScriptRoot/$Path"
+    }
+    Write-Host "Invoking Pester to run tests from '$testFilePath'..."
+    $testResult = Invoke-Pester $testFilePath -Passthru -Output Detailed
+    $testName = Split-Path $testFilePath –leaf
+    $testResult | Export-JUnitReport -Path "$testFileDirectory/$testName.xml"
+} else {
+    if ($Path) {
+        Write-Host "Invoking Pester to run tests from '$PSScriptRoot/$Path'"
+        Invoke-Pester -Output Detailed $PSScriptRoot/$Path
+    } else {
+        Write-Host "Invoking Pester to run tests from '$testFilePath'..."
+        Invoke-Pester -Output Detailed $testFilePath
+    }
+}

testing/bin/connectedk8s-1.0.0-py3-none-any.whl

@@ -0,0 +1,3 @@
+systemDefaultValues:
+  extensionoperator:
+    enabled: true