This is a test extension.
9 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /bats/tests/extensions/testdata/vm-compose.json: -------------------------------------------------------------------------------- 1 | { 2 | "icon": "extension-icon.svg", 3 | "info": "This image uses vm.composefile", 4 | "vm": { 5 | "composefile": "/compose/compose.yaml" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /bats/tests/extensions/testdata/vm-image.json: -------------------------------------------------------------------------------- 1 | { 2 | "icon": "extension-icon.svg", 3 | "info": "This extension contains a reference to an image.", 4 | "vm": { 5 | "image": "rd/extension/vm-image" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /bats/tests/helpers/kubernetes.bats: -------------------------------------------------------------------------------- 1 | load '../helpers/load' 2 | 3 | : "${RD_INFO:=false}" 4 | 5 | @test 'unwrap_kube_list: no list' { 6 | run echo '{"kind": "Pod"}' 7 | assert_success 8 | 9 | run unwrap_kube_list 10 | assert_success 11 | 12 | run jq_output .kind 13 | assert_success 14 | assert_output Pod 15 | } 16 | 17 | @test 'unwrap_kube_list: no items' { 18 | run echo '{"kind": "List"}' 19 | assert_success 20 | 21 | run unwrap_kube_list 22 | assert_failure 23 | } 24 | 25 | @test 'unwrap_kube_list: one item' { 26 | run echo '{"kind": "List", "items": [{"kind": "Pod"}]}' 27 | assert_success 28 | 29 | run unwrap_kube_list 30 | assert_success 31 | 32 | run jq_output .kind 33 | assert_success 34 | assert_output Pod 35 | } 36 | 37 | @test 'unwrap_kube_list: two items' { 38 | run echo '{"kind": "List", "items": [{"kind": "Pod"},{"kind": "Pod"}]}' 39 | assert_success 40 | 41 | run unwrap_kube_list 42 | assert_failure 43 | } 44 | 45 | @test 'unwrap_kube_list: not JSON' { 46 | run echo 'Some random error message' 47 | assert_success 48 | 49 | run unwrap_kube_list 50 | assert_failure 51 | } 52 | -------------------------------------------------------------------------------- /bats/tests/helpers/snapshots.bash: -------------------------------------------------------------------------------- 1 | delete_all_snapshots() { 2 | run rdctl snapshot list --json 3 | assert_success 4 | # On Windows, executing native Windows executables consumes stdin. 5 | # https://github.com/microsoft/WSL/issues/10429 6 | # Work around the issue by using `run` to populate `${lines[@]}` ahead of 7 | # time, so that we don't need the buffer during the loop. 8 | run jq_output .name 9 | assert_success 10 | local name 11 | for name in "${lines[@]}"; do 12 | rdctl snapshot delete "$name" 13 | done 14 | run rdctl snapshot list 15 | assert_success 16 | assert_output --partial 'No snapshots' 17 | } 18 | -------------------------------------------------------------------------------- /bats/tests/k8s/enable-disable-k8s.bats: -------------------------------------------------------------------------------- 1 | # Test case 8, 13, 22 2 | 3 | load '../helpers/load' 4 | 5 | @test 'factory reset' { 6 | factory_reset 7 | } 8 | 9 | verify_k8s_is_running() { 10 | wait_for_container_engine 11 | wait_for_service_status k3s started 12 | } 13 | 14 | @test 'start rancher desktop with kubernetes enabled' { 15 | start_kubernetes 16 | wait_for_kubelet 17 | verify_k8s_is_running 18 | } 19 | 20 | @test 'disable kubernetes' { 21 | rdctl set --kubernetes.enabled=false 22 | wait_for_container_engine 23 | wait_for_service_status k3s stopped 24 | } 25 | 26 | @test 're-enable kubernetes' { 27 | rdctl set --kubernetes.enabled=true 28 | wait_for_kubelet 29 | verify_k8s_is_running 30 | } 31 | -------------------------------------------------------------------------------- /bats/tests/k8s/foreach-k3s-version.bats: -------------------------------------------------------------------------------- 1 | load '../helpers/load' 2 | 3 | wait_for_dns() { 4 | try assert_pod_containers_are_running \ 5 | --namespace kube-system \ 6 | --selector k8s-app=kube-dns 7 | } 8 | 9 | foreach_k3s_version \ 10 | factory_reset \ 11 | start_kubernetes \ 12 | wait_for_kubelet \ 13 | wait_for_dns 14 | -------------------------------------------------------------------------------- /bats/tests/k8s/specify-invalid-k8s-version.bats: -------------------------------------------------------------------------------- 1 | load '../helpers/load' 2 | 3 | @test 'factory reset' { 4 | factory_reset 5 | } 6 | 7 | @test 'invalid k8s version' { 8 | start_kubernetes --kubernetes.version=moose 9 | wait_for_container_engine 10 | # Can't use wait_for_api_server because it hard-wires a valid k8s version and we're specifying an invalid one here. 11 | # and we're specifying an invalid one here 12 | local timeout="$(($(date +%s) + 10 * 60))" 13 | until kubectl get --raw /readyz &>/dev/null; do 14 | assert [ "$(date +%s)" -lt "$timeout" ] 15 | sleep 1 16 | done 17 | # No way there's a race-condition here. 18 | # The version was checked and written to the log file before starting k8s, 19 | # and we have to wait a few minutes before k8s is ready and we're at the next line. 20 | assert_file_contains "$PATH_LOGS/kube.log" "Requested kubernetes version 'moose' is not a supported version. Falling back to" 21 | } 22 | 23 | # on macOS it still hangs without this 24 | @test 'shutdown' { 25 | if is_macos; then 26 | rdctl shutdown 27 | fi 28 | } 29 | -------------------------------------------------------------------------------- /bats/tests/profile/wasm.bats: -------------------------------------------------------------------------------- 1 | load '../helpers/load' 2 | 3 | local_teardown_file() { 4 | foreach_profile delete_profile 5 | } 6 | 7 | @test 'create version 10 locked profile' { 8 | PROFILE_TYPE=$PROFILE_LOCKED 9 | create_profile 10 | add_profile_int version 10 11 | } 12 | 13 | @test 'start application' { 14 | factory_reset 15 | start_container_engine 16 | wait_for_container_engine 17 | } 18 | 19 | @test 'WASM mode should be locked down' { 20 | run rdctl set --experimental.container-engine.web-assembly.enabled 21 | assert_failure 22 | assert_output --partial 'field "experimental.containerEngine.webAssembly.enabled" is locked' 23 | } 24 | 25 | @test 'update locked profile to version 11' { 26 | PROFILE_TYPE=$PROFILE_LOCKED 27 | add_profile_int version 11 28 | } 29 | 30 | @test 'restart application with version 11 locked profile' { 31 | factory_reset 32 | start_container_engine 33 | wait_for_backend 34 | } 35 | 36 | @test 'WASM mode is now unlocked' { 37 | run rdctl set --experimental.container-engine.web-assembly.enabled 38 | assert_success 39 | assert_output --partial 'reconfiguring Rancher Desktop to apply changes' 40 | } 41 | -------------------------------------------------------------------------------- /bats/tests/snapshots/test_rdctl_snapshot.bats: -------------------------------------------------------------------------------- 1 | load '../helpers/load' 2 | 3 | # TODO: Uncomment this test when snapshots go unhidden. 4 | #@test 'snapshot shows up in general help' { 5 | # run rdctl --help 6 | # assert_success 7 | # assert_output -partial snapshot 8 | #} 9 | 10 | @test 'complain about missing argument' { 11 | # These test the rdctl cmd layer, can't be easily unit-tested 12 | for arg in create restore delete; do 13 | run rdctl snapshot "$arg" 14 | assert_failure 15 | done 16 | } 17 | -------------------------------------------------------------------------------- /build/signing-config-win.yaml: -------------------------------------------------------------------------------- 1 | # This file describes the code signing configuration for Windows. 2 | 3 | # The key is a directory name, relative to the unpacked zip file. 4 | # The value is an array of files in that directory to sign, or an explicit 5 | # negation (prefixed with "!"). Any files not listed is an error. 6 | .: 7 | - Rancher Desktop.exe 8 | - wix-custom-action.dll 9 | - '!d3dcompiler_47.dll' # spellcheck-ignore-line 10 | - '!ffmpeg.dll' 11 | - '!libEGL.dll' # spellcheck-ignore-line 12 | - '!libGLESv2.dll' # spellcheck-ignore-line 13 | - '!vk_swiftshader.dll' # spellcheck-ignore-line 14 | - '!vulkan-1.dll' # spellcheck-ignore-line 15 | resources/resources/win32/bin: 16 | - docker.exe 17 | - docker-credential-none.exe 18 | - nerdctl.exe 19 | - rdctl.exe 20 | - spin.exe 21 | - '!docker-credential-ecr-login.exe' 22 | - '!docker-credential-wincred.exe' 23 | - '!helm.exe' 24 | - '!kubectl.exe' 25 | - '!kuberlr.exe' 26 | resources/resources/win32/docker-cli-plugins: 27 | - '!docker-buildx.exe' 28 | - '!docker-compose.exe' 29 | resources/resources/win32/internal: 30 | - host-switch.exe 31 | - steve.exe 32 | - wsl-helper.exe 33 | - '!spin.exe' 34 | -------------------------------------------------------------------------------- /build/wix/bannrbmp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rancher-sandbox/rancher-desktop/0216266849036b910dd0edd5c9f3c28a3424320e/build/wix/bannrbmp.png -------------------------------------------------------------------------------- /build/wix/dlgbmp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rancher-sandbox/rancher-desktop/0216266849036b910dd0edd5c9f3c28a3424320e/build/wix/dlgbmp.png -------------------------------------------------------------------------------- /dev-app-update.yml: -------------------------------------------------------------------------------- 1 | owner: rancher-sandbox 2 | repo: rancher-desktop 3 | updaterCacheDirName: rancher-desktop 4 | provider: custom 5 | upgradeServer: https://desktop.version.rancher.io/v1/checkupgrade 6 | vPrefixedTagName: true 7 | -------------------------------------------------------------------------------- /docs/assets/images/contributing/e2e-failure-reports.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rancher-sandbox/rancher-desktop/0216266849036b910dd0edd5c9f3c28a3424320e/docs/assets/images/contributing/e2e-failure-reports.png -------------------------------------------------------------------------------- /docs/assets/images/contributing/e2e-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rancher-sandbox/rancher-desktop/0216266849036b910dd0edd5c9f3c28a3424320e/docs/assets/images/contributing/e2e-summary.png -------------------------------------------------------------------------------- /docs/development/README.md: -------------------------------------------------------------------------------- 1 | # Developer Documentation 2 | 3 | Note that the below table of contents may be out of date 4 | (we may forget to update it). If you don't find what you need, 5 | ask around! 6 | 7 | [Information About Factory Reset](factory-reset.md) 8 | [Feature Tracker](features.md) 9 | [Tips for Working with OBS](obs.md) 10 | [Linux Release Process](linux-release-process.md) 11 | [Release Checklist](release-checklist.md) 12 | [Signing Rancher Desktop Releases](signing.md) 13 | [Generating Screenshots for User Documentation](../../screenshots/README.md) 14 | [Information on how to setup and run BATS tests](../../bats/README.md) 15 | -------------------------------------------------------------------------------- /docs/development/env.md: -------------------------------------------------------------------------------- 1 | # Internal Rancher Desktop environment variables 2 | 3 | These variables are used for build and development purposes; they are not meant to be set by users. 4 | 5 | They do not form an API and may be changed or removed at any time without prior notice. 6 | 7 | ## RD_DEBUG_ENABLED=anything 8 | 9 | Forces debug logging to always be enabled. Useful to debug first-run issues when there is no `settings.yaml` yet to set debug mode. 10 | 11 | ## RD_FORCE_UPDATES_ENABLED=anything 12 | 13 | When set, it will force auto-update to be enabled even in `yarn dev` mode. Updates will be checked and downloaded, but **not** installed. 14 | 15 | ## RD_MOCK_MACOS_VERSION=semver 16 | 17 | Used for testing compatibility of the app with the OS version, for upgrade responder tests, and for enabling/disabling certain parts of the preferences (related to VZ emulation mode). 18 | 19 | ## RD_UPGRADE_RESPONDER_URL=http://localhost:8314/v1/checkupgrade 20 | 21 | Set an alternate upgrade responder endpoint for testing. 22 | -------------------------------------------------------------------------------- /docs/development/factory-reset.md: -------------------------------------------------------------------------------- 1 | When `rdctl factory-reset` is launched from the UI, it writes its stdout into 2 | `TMP/rdctl-stdout.txt` 3 | 4 | where on linux `TMP` is usually `/tmp`, 5 | 6 | on macOS it's given by `$TMPDIR` 7 | 8 | and on Windows by `%TEMP%`(command shell) or `$env:TEMP`(powershell). 9 | 10 | 11 | This is most useful during development. When the UI runs in debug mode, it spawns `rdctl factory-reset` with the `--verbose` option. 12 | 13 | We can't write the output into the `logs` directory as `factory-reset` deletes it. 14 | -------------------------------------------------------------------------------- /e2e/assets/k8s-deploy-sample/nginx-sample-app.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: nginx-app 5 | spec: 6 | selector: 7 | matchLabels: 8 | app: nginx 9 | version: v1 10 | replicas: 1 11 | template: 12 | metadata: 13 | labels: 14 | app: nginx 15 | version: v1 16 | spec: 17 | containers: 18 | - name: nginx 19 | image: nginx:latest 20 | ports: 21 | - containerPort: 80 22 | --- 23 | apiVersion: v1 24 | kind: Service 25 | metadata: 26 | name: nginx-app 27 | labels: 28 | app: nginx 29 | spec: 30 | type: NodePort 31 | ports: 32 | - port: 80 33 | name: http 34 | selector: 35 | app: nginx 36 | -------------------------------------------------------------------------------- /e2e/config/playwright-config.ts: -------------------------------------------------------------------------------- 1 | import * as path from 'path'; 2 | 3 | import type { Config, PlaywrightTestOptions } from '@playwright/test'; 4 | 5 | const outputDir = path.join(__dirname, '..', 'e2e', 'test-results'); 6 | const testDir = path.join(__dirname, '..', '..', 'e2e'); 7 | // The provisioned github runners are much slower overall than cirrus's, so allow 2 hours for a full e2e run 8 | const timeScale = process.env.CI ? 4 : 1; 9 | 10 | const config: Config10 | Rancher Desktop is an open-source project to bring Kubernetes and container management to the desktop 11 |
12 |
23 | {{ error }}
24 |
25 | 7 | Rancher Desktop cannot be run with root privileges. 8 | Please run again as a regular user. 9 |
10 | 19 |