Merge pull request ActiveState#3286 from ActiveState/version/0-44-0-RC3

Version 0.44.0-RC3

Author: Naatan

.github/workflows/build.yml

@@ -29,7 +29,6 @@ env:
 
 # === JOBS ===
 jobs:
-
   # === OS Specific Job (runs on each OS) ===
   os_specific:
     name: ${{ matrix.sys.os }}
@@ -39,8 +38,8 @@ jobs:
         go-version:
           - 1.20.x
         sys:
-          - {os: ubuntu-20.04}
-          - {os: macos-11, shell: zsh}
+          - {os: ubuntu-latest}
+          - {os: macos-12, shell: zsh}
           - {os: windows-2019}
       fail-fast: false
     runs-on: ${{ matrix.sys.os }}
@@ -130,6 +129,10 @@ jobs:
           export PATH="$(pwd)/.github/deps/${{ runner.os }}/bin:$PATH"
           parallelize "$(cat <<'EOF'
           [
+            {
+                "ID": "Check-Format",
+                "Args": ["state", "run", "check-format"]
+            },
             {
                 "ID": "Unit-Tests",
                 "Args": ["state", "run", "test", "-json", "2>&1"]
@@ -168,6 +171,13 @@ jobs:
           JIRA_USERNAME: ${{ secrets.JIRA_EMAIL }}
           JIRA_TOKEN: ${{ secrets.JIRA_TOKEN }}
 
+      - # === Unit Tests ===
+        name: Check Format
+        id: check_format
+        shell: bash
+        if: "!contains(fromJSON('[\"refs/heads/beta\", \"refs/heads/release\", \"refs/heads/LTS\"]'), github.ref) && !startsWith(github.event.pull_request.head.ref, 'version/')"
+        run: parallelize results Check-Format
+
       - # === Unit Tests ===
         name: Unit Tests
         id: unit_tests
@@ -323,7 +333,7 @@ jobs:
           export TEST_SUITE_TAGS="$TEST_SUITE_TAGS"
           TIMEOUT=30m
           if [[ "$TEST_SUITE_TAGS" == "all" ]]; then
-            TIMEOUT=60m
+            TIMEOUT=90m
           fi
           SHELL='${{ matrix.sys.shell }}' go test -timeout $TIMEOUT -v `go list ./... | grep "integration"` -json 2>&1 | gotestfmt -hide empty-packages
         continue-on-error: ${{ github.event_name == 'schedule' }}

.golangci.yaml

@@ -1,10 +1,15 @@
-run:
-  skip-dirs:
+issues:
+  exclude-dirs:
     - vendor
+  exclude-rules:
+    - linters:
+        - staticcheck
+      text: "SA9004"
 
 linters-settings:
   errcheck:
     exclude-functions:
+      - fmt.Fprintln
       - (*github.com/ActiveState/termtest.TermTest).Expect
       - (*github.com/ActiveState/termtest.TermTest).ExpectExitCode
       - (*github.com/ActiveState/termtest.TermTest).ExpectNotExitCode
@@ -13,9 +18,24 @@ linters-settings:
       - (*github.com/ActiveState/termtest.TermTest).WaitForInput
       - (*github.com/ActiveState/termtest.TermTest).SendLine
       - (*github.com/ActiveState/termtest.TermTest).ExpectInput
+      - (*github.com/ActiveState/termtest.TermTest).ExpectExit
       - (*github.com/ActiveState/termtest.TermTest).Wait
       - (*github.com/ActiveState/logging.fileHandler).Printf
       - (*github.com/ActiveState/logging.standardHandler).Printf
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.Session).Close
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.SpawnedCmd).ExpectInput
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.SpawnedCmd).Send
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.SpawnedCmd).SendLine
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.SpawnedCmd).SendEnter
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.SpawnedCmd).SendKeyDown
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.SpawnedCmd).ExpectRe
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.SpawnedCmd).Wait
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.Session).ClearCache
+      - (*github.com/ActiveState/cli/internal/testhelpers/e2e.Dirs).Close
+      - (*github.com/ActiveState/cli/pkg/platform/runtime/artifactcache.testArtifactCache).Store
+      - github.com/ActiveState/cli/internal/testhelpers/osutil.RemoveConfigFile
+      - (*github.com/ActiveState/cli/internal/logging.standardHandler).Emit
+      - (*github.com/ActiveState/cli/internal/logging.fileHandler).Emit
   govet:
     disable:
       - composites

activestate.yaml

@@ -360,6 +360,40 @@ scripts:
     value: |
       golangci-lint run --no-config
       actionlint
+  - name: check-format
+    language: bash
+    description: "Checks if the code is formatted correctly"
+    value: |
+      set -e
+
+      TARGET_BRANCH=$GITHUB_BASE_REF
+      if [ "$GITHUB_BASE_REF" == "" ]; then
+        TARGET_BRANCH="master"
+      fi
+
+      git fetch --quiet origin $TARGET_BRANCH:refs/remotes/origin/$TARGET_BRANCH
+
+      CHANGED=$(git diff --name-only origin/$TARGET_BRANCH)
+      NO_NEWLINE=0
+      for FILE in $CHANGED; do
+          if [[ $FILE == vendor/* ]]; then
+              continue
+          fi
+
+          if file "$FILE" | grep -q -E 'text|ASCII'; then
+              if [ $(tail -c 1 "$FILE" | wc -l) -eq 0 ]; then
+                  echo "Missing newline at end of file: $FILE"
+                  NO_NEWLINE=1
+              fi
+          fi
+      done
+
+      if [ "$NO_NEWLINE" -ne 0 ]; then
+          echo "Error: Some text files are missing a newline at the end."
+          exit 1
+      else
+          echo "Success: All modified text files end with a newline."
+      fi
   - name: grab-mergecommits
     language: bash
     value: |

changelog.md

@@ -6,6 +6,66 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.44.0
+
+### Added
+
+* We've added the `state manifest` command, which lists all your package, bundle and language requirements in your
+  project. This command deprecates the old `state packages`, `state languages` and `state bundles` commands.
+* `state artifacts` now indicates which artifacts are still building.
+* You can now use wildcard versions when running `state install` and `state languages install`, just like you can
+  with `state init`. eg. `state install [email protected]`.
+* We now warn you when installing the State Tool as an administrator on Windows.
+* `state publish` now lets you specify the type of a dependency (ie. runtime, buildtime, or testing) via the new
+  `--depend-build`, `--depend-runtime` and `--depend-test` flags. The existing `--depend` flag maps to `--depend-build`.
+* We now ensure the runtime is not currently in use before making changes to it. If the runtime is the user will receive
+  an error asking them to stop using the runtime before proceeding.
+* You can now supply multiple packages to the `state install` and `state uninstall` commands.
+
+### Changed
+
+* Increased the time State Tool will wait for the state-svc to start, which is required for using the State Tool. This
+  is mainly intended for when you just started your system, when it is still under heavy load and thus processes can
+  take longer to start.
+* You will now receive an actionable error when your activestate.yaml does not contain a commit ID.
+* State revert "HEAD" has been renamed to "REMOTE", though "HEAD" is still supported with a deprecation warning. This
+  is to avoid confusion with how git uses the HEAD term, which isn't how we were using it.
+* `state run` and `state exec` now use powershell under the hood instead of cmd. This means that invoking shell
+  built-ins like `where` will no longer work as powershell has different built-ins. But if you're invoking shell
+  built-ins you probably shouldn't be using these commands anyway.
+* State tool now identifies more network errors, making for more actionable error messages.
+* We have introduced a new project file versioning mechanic. You'll start seeing a new `config_version` property in your
+  activestate.yaml. Do not edit or delete this or you may run into issues.
+* Buildscripts are no longer automatically created when opted in. Instead you need to run `state reset LOCAL` in order
+  to first create the buildscript. You only need to do this once, after it exists it will be updated as needed.
+    * This is merely a growing pain while this feature is optin only. Once buildscripts ship as stable you will not need
+      to do this.
+* CVE information provided when running `state install` is now recursive, meaning we show CVE information for the
+  requested package as well as all its dependencies.
+* `state init` now automatically assumes wildcards when a partial version is specified.
+
+### Fixed
+
+* Fixed issue where `state refresh` would tell you you have uncommitted changes when you are up to date (when opted into
+  buildscripts).
+* Fixed issue where `state uninstall` would give you superfluous output intended for `state install`.
+* Fixed issue where running `state update` would show deprecation messages for the version you are updating from.
+* Fixed issue where `state run` and `state exec` would not forward arguments correctly on Windows. This is a limitation
+  of the `cmd` shell. We now utilize powershell instead to facilitate commands.
+* Fixed issue where `state languages` would show a larger than / smaller than version notation rather than `auto`.
+* Fixed issue where `state checkout` would save the `main` branch to your activestate.yaml when you checked out a commit
+  on a sub-branch. It now correctly saves the sub-branch.
+* Fixed issue where `state search` gave an unintended "wrapped tips" error when given an invalid version number.
+* Fixed issue where text was wrapped when producing non-interactive output, making it impossible to use the output in
+  automations without first cleaning up the output.
+* Fixed issue where manually resolving conflicts when running `state pull` would not allow you to commit these changes
+  if you picked only the local changes. This only applies if opted in to buildscripts.
+* Fixed issue where conflicts on the `at_time` buildscript field would show the wrong local value.
+
+### Removed
+
+* `state export recipe` has been removed, as the platform no longer uses recipes.
+
 ## 0.43.0
 
 ### Added

cmd/state-installer/cmd.go

@@ -34,7 +34,7 @@ import (
 	"github.com/ActiveState/cli/internal/subshell/bash"
 	"github.com/ActiveState/cli/pkg/project"
 	"github.com/ActiveState/cli/pkg/sysinfo"
-	"golang.org/x/crypto/ssh/terminal"
+	"golang.org/x/term"
 )
 
 type Params struct {
@@ -47,10 +47,15 @@ type Params struct {
 	activate        *project.Namespaced
 	activateDefault *project.Namespaced
 	showVersion     bool
+	nonInteractive  bool
 }
 
 func newParams() *Params {
-	return &Params{activate: &project.Namespaced{}, activateDefault: &project.Namespaced{}}
+	return &Params{
+		activate:        &project.Namespaced{},
+		activateDefault: &project.Namespaced{},
+		nonInteractive:  !term.IsTerminal(int(os.Stdin.Fd())),
+	}
 }
 
 func main() {
@@ -109,7 +114,6 @@ func main() {
 		return
 	}
 
-	var garbageBool bool
 	var garbageString string
 
 	// We have old install one liners around that use `-activate` instead of `--activate`
@@ -189,8 +193,8 @@ func main() {
 				Name:  "version", // note: no shorthand because install.sh uses -v for selecting version
 				Value: &params.showVersion,
 			},
+			{Name: "non-interactive", Shorthand: "n", Hidden: true, Value: &params.nonInteractive}, // don't prompt
 			// The remaining flags are for backwards compatibility (ie. we don't want to error out when they're provided)
-			{Name: "nnn", Shorthand: "n", Hidden: true, Value: &garbageBool}, // don't prompt; useless cause we don't prompt anyway
 			{Name: "channel", Hidden: true, Value: &garbageString},
 			{Name: "bbb", Shorthand: "b", Hidden: true, Value: &garbageString},
 			{Name: "vvv", Shorthand: "v", Hidden: true, Value: &garbageString},
@@ -341,7 +345,7 @@ func installOrUpdateFromLocalSource(out output.Outputer, cfg *config.Instance, a
 		return err
 	}
 
-	installer, err := NewInstaller(cfg, out, payloadPath, params)
+	installer, err := NewInstaller(cfg, out, an, payloadPath, params)
 	if err != nil {
 		out.Print(fmt.Sprintf("[ERROR]Could not create installer: %s[/RESET]", errs.JoinMessage(err)))
 		return err
@@ -424,7 +428,7 @@ func postInstallEvents(out output.Outputer, cfg *config.Instance, an analytics.D
 			an.EventWithLabel(anaConst.CatInstallerFunnel, "forward-activate-default-err", err.Error())
 			return errs.Silence(errs.Wrap(err, "Could not activate %s, error returned: %s", params.activateDefault.String(), errs.JoinMessage(err)))
 		}
-	case !params.isUpdate && terminal.IsTerminal(int(os.Stdin.Fd())) && os.Getenv(constants.InstallerNoSubshell) != "true" && os.Getenv("TERM") != "dumb":
+	case !params.isUpdate && term.IsTerminal(int(os.Stdin.Fd())) && os.Getenv(constants.InstallerNoSubshell) != "true" && os.Getenv("TERM") != "dumb":
 		if err := ss.SetEnv(osutils.InheritEnv(envMap(binPath))); err != nil {
 			return locale.WrapError(err, "err_subshell_setenv")
 		}
@@ -489,37 +493,3 @@ func assertCompatibility() error {
 
 	return nil
 }
-
-func noArgs() bool {
-	return len(os.Args[1:]) == 0
-}
-
-func shouldUpdateInstalledStateTool(stateExePath string) bool {
-	logging.Debug("Checking if installed state tool is an older version.")
-
-	stdout, _, err := osutils.ExecSimple(stateExePath, []string{"--version", "--output", "json"}, os.Environ())
-	if err != nil {
-		logging.Debug("Could not determine state tool version.")
-		return true // probably corrupted install
-	}
-	stdout = strings.Split(stdout, "\x00")[0] // TODO: DX-328
-
-	versionData := installation.VersionData{}
-	err = json.Unmarshal([]byte(stdout), &versionData)
-	if err != nil {
-		logging.Debug("Could not read state tool version output")
-		return true
-	}
-
-	if versionData.Channel != constants.ChannelName {
-		logging.Debug("State tool channel is different from installer.")
-		return false // do not update, require --force
-	}
-
-	if versionData.Version != constants.Version {
-		logging.Debug("State tool version is different from installer.")
-		return true
-	}
-
-	return false
-}

cmd/state-installer/installer.go

@@ -2,13 +2,13 @@ package main
 
 import (
 	"errors"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
 
 	svcApp "github.com/ActiveState/cli/cmd/state-svc/app"
 	svcAutostart "github.com/ActiveState/cli/cmd/state-svc/autostart"
+	"github.com/ActiveState/cli/internal/analytics"
 	"github.com/ActiveState/cli/internal/config"
 	"github.com/ActiveState/cli/internal/constants"
 	"github.com/ActiveState/cli/internal/errs"
@@ -22,6 +22,8 @@ import (
 	"github.com/ActiveState/cli/internal/osutils"
 	"github.com/ActiveState/cli/internal/osutils/autostart"
 	"github.com/ActiveState/cli/internal/output"
+	"github.com/ActiveState/cli/internal/prompt"
+	"github.com/ActiveState/cli/internal/rtutils/ptr"
 	"github.com/ActiveState/cli/internal/subshell"
 	"github.com/ActiveState/cli/internal/subshell/sscommon"
 	"github.com/ActiveState/cli/internal/updater"
@@ -30,12 +32,13 @@ import (
 type Installer struct {
 	out         output.Outputer
 	cfg         *config.Instance
+	an          analytics.Dispatcher
 	payloadPath string
 	*Params
 }
 
-func NewInstaller(cfg *config.Instance, out output.Outputer, payloadPath string, params *Params) (*Installer, error) {
-	i := &Installer{cfg: cfg, out: out, payloadPath: payloadPath, Params: params}
+func NewInstaller(cfg *config.Instance, out output.Outputer, an analytics.Dispatcher, payloadPath string, params *Params) (*Installer, error) {
+	i := &Installer{cfg: cfg, out: out, an: an, payloadPath: payloadPath, Params: params}
 	if err := i.sanitizeInput(); err != nil {
 		return nil, errs.Wrap(err, "Could not sanitize input")
 	}
@@ -46,6 +49,21 @@ func NewInstaller(cfg *config.Instance, out output.Outputer, payloadPath string,
 }
 
 func (i *Installer) Install() (rerr error) {
+	isAdmin, err := osutils.IsAdmin()
+	if err != nil {
+		return errs.Wrap(err, "Could not determine if running as Windows administrator")
+	}
+	if isAdmin && !i.Params.force && !i.Params.isUpdate && !i.Params.nonInteractive {
+		prompter := prompt.New(true, i.an)
+		confirm, err := prompter.Confirm("", locale.T("installer_prompt_is_admin"), ptr.To(false))
+		if err != nil {
+			return errs.Wrap(err, "Unable to confirm")
+		}
+		if !confirm {
+			return locale.NewInputError("installer_aborted", "Installation aborted by the user")
+		}
+	}
+
 	// Store update tag
 	if i.updateTag != "" {
 		if err := i.cfg.Set(updater.CfgUpdateTag, i.updateTag); err != nil {
@@ -59,7 +77,7 @@ func (i *Installer) Install() (rerr error) {
 	}
 
 	// Detect if existing installation needs to be cleaned
-	err := detectCorruptedInstallDir(i.path)
+	err = detectCorruptedInstallDir(i.path)
 	if errors.Is(err, errCorruptedInstall) {
 		err = i.sanitizeInstallPath()
 		if err != nil {
@@ -97,10 +115,6 @@ func (i *Installer) Install() (rerr error) {
 
 	// Set up the environment
 	binDir := filepath.Join(i.path, installation.BinDirName)
-	isAdmin, err := osutils.IsAdmin()
-	if err != nil {
-		return errs.Wrap(err, "Could not determine if running as Windows administrator")
-	}
 
 	// Install the state service as an app if necessary
 	if err := i.installSvcApp(binDir); err != nil {
@@ -194,7 +208,7 @@ func detectCorruptedInstallDir(path string) error {
 	}
 
 	// Detect if the install dir has files in it
-	files, err := ioutil.ReadDir(path)
+	files, err := os.ReadDir(path)
 	if err != nil {
 		return errs.Wrap(err, "Could not read directory: %s", path)
 	}