Skip to content

About

SSaltStack-based content for installing and configuring the VSCode IDE to selected client-types

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

vscode-ide-formula

A SaltStack formula designed to install and configure the VSCode IDE package on installation-targets.

It is primarily expected that this formula will be run via P3's "watchmaker" framework.

Available states

vscode-ide

Executes the package and config states to install and configure the VSCode IDE

vscode-ide.clean

Executes the package and config states' clean actions to fully uninstall the VSCode IDE and remove previously-installed browser policy-configs (and, on Windows, associated registry entries)

vscode-ide.package

Executes just the package state to install the VSCode IDE package.

vscode-ide.package.clean

Executes just the package.clean state to uninstall the VSCode IDE package.

vscode-ide.config

Executes just the config state to install/configure the VSCode IDE client-configuration (etc.) files

vscode-ide.config.clean

Executes just the config state to uninstall the VSCode IDE client-configuration (etc.) files and, on Windows, remove any registry-keys set by prior install-runs of the formula.

Testing

Primary integration-testing is done at the git repository-server. For this project's "upstream" home, the repository-server is GitHub.com. This primary integration-testing is handled primarily via GitHub actions.

Local integration-testing may be executed via Test Kitchen and Chef InSpec. This may be done directly on the local host or against containerized Salt minion instances. Local integration-testing is recommended to help reduce the likelihood that server-side testing will fail when submitting pull-requests.

Local Testing with Podman

If your development workstation lacks Ruby or native Test Kitchen tooling, you can execute the test suite inside a rootless Podman runner container:

  1. Enable the user-level Podman socket:

    systemctl --user enable --now podman.socket
  2. Execute Kitchen verification1:

    podman run \
      --rm \
      -it \
      --network host \
      -v /run/user/$( id -u )/podman/podman.sock:/var/run/docker.sock \
      -v "$PWD":/workspace:Z \
      -w /workspace \
      -e DOCKER_HOST=unix:///var/run/docker.sock \
      -e DOCKER_BUILDKIT=0 docker.io/techneg/ci-docker-python-ruby:latest \
      bash -c "bundle install && bundle exec kitchen verify almalinux-9-latest"

Windows Testing via AWS-Hosted Target

To verify Windows target hosts in isolated VPCs without exposing public WinRM ports or adding persistent target credentials to repository configuration files, use the following process that leverages SSM Port Forwarding. This process will require two terminal sessions:

  1. Target Instance Preparation: Ensure the target EC2 instance has WinRM enabled (port 5985) and a local Administrator password set (e.g., via userData). This can be done via userData payload. If using a multi-part payload, add the following to any:
      - task: executeScript
        inputs:
    Section2:
          # Set up WinRM
          - frequency: once
            type: powershell
            runAs: localSystem
            content: |
              # ==============================================================================
              # WINRM CONFIGURATION FOR INSPEC TESTING VIA SSM PORT FORWARDING
              # ==============================================================================
              $ErrorActionPreference = "Stop"
    
              # Enable WinRM HTTP listener and local authentication
              winrm quickconfig -q
              Set-Item WSMan:\localhost\Service\Auth\Basic $true
              Set-Item WSMan:\localhost\Service\AllowUnencrypted $true
    
              # Ensure local firewall permits inbound traffic on WinRM port 5985
              New-NetFirewallRule -Action Allow `
                                  -Direction Inbound `
                                  -DisplayName "WinRM HTTP for InSpec" `
                                  -Enabled True `
                                  -LocalPort 5985 `
                                  -Name "WinRM-HTTP-InSpec" `
                                  -Protocol TCP
    
              # Set local Administrator password for workstation WinRM authentication
              $AdminAccount = [adsi]"WinNT://./Administrator,user"
              $AdminAccount.SetPassword("TargetWinRMSecurePass123!")
    
  2. Open SSM Tunnel: In Terminal 1, establish an AWS Systems Manager port forwarding session to bridge local port 5985 to the EC2 target:
    aws ssm start-session \
      --target <EC2_INSTANCE_ID>\
      --document-name AWS-StartPortForwardingSession \
      --parameters '{"portNumber":["5985"],"localPortNumber":["5985"]}'
  3. Execute InSpec Controls: In Terminal 2, run the containerized InSpec suite targeting the local end of the WinRM tunnel:
    export WINRM_PASS="TargetWinRMSecurePass123!"
    
    podman run \
      --rm \
      -it \
      --network host \
      -v "$PWD":/workspace:Z \
      -w /workspace \
      -e WINRM_PASS \
      docker.io/techneg/ci-docker-python-ruby:latest \
      bash -c 'bundle install && bundle exec ruby -e "
        require \"inspec/cli\"
        Inspec::InspecCLI.start([
          \"exec\",
          \"test/integration/default\",
          \"--backend\", \"winrm\",
          \"--host\", \"localhost\",
          \"--port\", \"5985\",
          \"--user\", \"Administrator\",
          \"--password\", ENV[\"WINRM_PASS\"]
        ])
      "'

Compatibility Notes:

Linux

Should work on all Enterprise Linux and derived distros that leverage dnf. However, project-content has only been specifically testd on Enterprise Linux 8 and 9 variants (RHEL, AlmaLinux, Rocky Linux, CentOS Stream).

Similary, while dnf-based installations should work with vendor and private repositories, the method was only specifically tested using the official Microsoft YUM repositories.

Windows

Should work with self-hosted installer-files and for arbitrary version-specificatons. However, it was only specifically tested on Windows Server 2022 using the official, Microsoft-hosted installers and only requested the "latest" version. As such, download-sources were identified using dynamic queries of the VSCode Update API to build local winrepo package definitions and installs machine-wide to C:\Program Files.

Footnotes

  1. While this project's kitchen.yaml file has mappings for Alma and Rocky Linux 10, using them currently does not work. The necessary (official) Docker images do not exist on Docker Hub. The upstream saltstack-formulas project-owners maintain pre-salted test images for Enterprise Linux 8 and 9 (AlmaLinux, Rocky Linux, RHEL, CentOS Stream). However, as of this README's writings, EL10 images have not yet been built or tagged. ↩

  2. It is expected that, in addition to being deployed into a private VPC, the testing-EC2 will be ephemeral. As such, using a trivial, throwaway password is acceptable for the type of ad hoc testing being described in this document. ↩

About

SSaltStack-based content for installing and configuring the VSCode IDE to selected client-types

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

Generated from plus3it/repo-template