improve update command (#163)

* update updates

* update updates

* update

* update

* update

* update

* update

* swap to option to represent no answer

* swap to option to represent no answer from isOutdated

* swap to option to represent no answer from isOutdated

* rename

* rename

* rename again

Author: elcritch

atlas.nimble

@@ -1,5 +1,5 @@
 # Package
-version = "0.9.1"
+version = "0.9.2"
 author = "Araq"
 description = "Atlas is a simple package cloner tool. It manages an isolated project."
 license = "MIT"

src/atlas.nim

@@ -9,7 +9,7 @@
 ## Simple tool to automate frequent workflows: Can "clone"
 ## a Nimble dependency and its dependencies recursively.
 
-import std / [parseopt, files, dirs, strutils, os, osproc, tables, sets, json, uri, paths]
+import std / [parseopt, files, dirs, strutils, os, options, osproc, tables, sets, json, uri, paths]
 import basic / [versions, context, osutils, configutils, reporters,
                 nimbleparser, gitops, pkgurls, nimblecontext, compiledpatterns, packageinfos]
 import depgraphs, nimenv, lockfiles, confighandler, dependencies, pkgsearch
@@ -46,13 +46,13 @@ Command:
   install               use the nimble file to setup the project's dependencies
   link <path>           link an existing project into the current project
                         to share its dependencies
-  update <url|pkgname>  update a package and all of its dependencies
+  update [filter]       update every dependency that matches the filter
+                        whether by name or URL. All dependencies are updated
+                        if no filter is given.
   search <keyA> [keyB ...]
                         search for package that contains the given keywords
   extract <file.nimble> extract the requirements and custom commands from
                         the given Nimble file
-  updateDeps [filter]   update every dependency that has a remote
-                        URL that matches `filter` if a filter is given
   tag [major|minor|patch]
                         add and push a new tag, input must be one of:
                         ['major'|'minor'|'patch'] or a SemVer tag like ['1.0.3']
@@ -305,17 +305,23 @@ proc listOutdated() =
   for pkg in allNodes(graph):
     if pkg.isRoot:
       continue
-    if gitops.isOutdated(pkg.ondisk):
-      warn pkg.url.projectName, "is outdated"
+    let res = gitops.hasNewTags(pkg.ondisk)
+    if res.isNone:
+      warn pkg.url.projectName, "no remote version tags found"
       inc updateable
     else:
-      notice pkg.url.projectName, "is up to date"
+      let (outdated, cnt) = res.get()
+      if outdated:
+        warn pkg.url.projectName, "is outdated; " & $cnt & " new tags available"
+        inc updateable
+      else:
+        notice pkg.url.projectName, "is up to date"
 
   if updateable == 0:
     info project(), "all packages are up to date"
 
-proc updateWorkspace(filter: string) =
-  ## update the workspace
+proc update(filter: string) =
+  ## update the dependencies
   ##
   ## this will update the workspace by checking for outdated packages and
   ## updating them if they are outdated
@@ -332,16 +338,26 @@ proc updateWorkspace(filter: string) =
       continue
 
     let url = gitops.getRemoteUrl(pkg.ondisk)
+    if url.len == 0:
+      warn pkg.url.projectName, "no remote URL found; skipping..."
+      continue
     if url.len == 0 or filter notin url or filter notin pkg.url.projectName:
-      warn pkg.url.projectName, "not checking for updates"
+      warn pkg.url.projectName, "filter not matched; skipping..."
       continue
 
-    if gitops.isOutdated(pkg.ondisk):
-      warn pkg.url.projectName, "is outdated, updating..."
-      gitops.updateRepo(pkg.ondisk)
+    let res = gitops.hasNewTags(pkg.ondisk)
+    if res.isNone:
+      warn pkg.url.projectName, "no remote version tags found, updating origin instead"
+      gitops.updateRepo(pkg.ondisk, onlyTags = false)
       needsUpdate = true
     else:
-      notice pkg.url.projectName, "is up to date"
+      let (outdated, cnt) = res.get()
+      if outdated and cnt > 0:
+        warn pkg.url.projectName, "outdated, updating... " & $cnt & " new tags available"
+        gitops.updateRepo(pkg.ondisk, onlyTags = true)
+        needsUpdate = true
+      else:
+        notice pkg.url.projectName, "up to date"
 
   if needsUpdate:
     notice project(), "new dep versions available, run `atlas install` to update"
@@ -556,7 +572,7 @@ proc atlasRun*(params: seq[string]) =
     installDependencies(nc, nimbleFile)
 
   of "update":
-    updateWorkspace(if args.len == 0: "" else: args[0])
+    update(if args.len == 0: "" else: args[0])
 
   of "use":
     singleArg()

src/basic/gitops.nim

@@ -6,7 +6,7 @@
 #    distribution, for details about the copyright.
 #
 
-import std/[os, files, dirs, paths, osproc, sequtils, strutils, uri, sets]
+import std/[os, files, dirs, paths, osproc, options, sequtils, strutils, uri, sets]
 import reporters, osutils, versions, context
 
 type
@@ -15,6 +15,7 @@ type
     GitRemoteUrl = "git -C $DIR config --get remote.origin.url",
     GitDiff = "git -C $DIR diff",
     GitFetch = "git -C $DIR fetch",
+    GitFetchAll = "git -C $DIR fetch origin " & quoteShell("refs/heads/*:refs/heads/*") & " " & quoteShell("refs/tags/*:refs/tags/*"),
     GitTag = "git -C $DIR tag",
     GitTags = "git -C $DIR show-ref --tags",
     GitLastTaggedRef = "git -C $DIR rev-list --tags --max-count=1",
@@ -29,7 +30,7 @@ type
     GitLsFiles = "git -C $DIR ls-files"
     GitLog = "git -C $DIR log --format=%H origin/HEAD"
     GitLogLocal = "git -C $DIR log --format=%H HEAD"
-    GitCurrentBranch = "git rev-parse --abbrev-ref HEAD"
+    GitCurrentBranch = "git -C $DIR rev-parse --abbrev-ref HEAD"
     GitLsRemote = "git -C $DIR ls-remote --quiet --tags"
     GitShowFiles = "git -C $DIR show"
     GitListFiles = "git -C $DIR ls-tree --name-only -r"
@@ -193,9 +194,9 @@ proc shortToCommit*(path: Path, short: CommitHash): CommitHash =
     if vtags.len() == 1:
       result = vtags[0].c
 
-proc expandSpecial*(path: Path, vtag: VersionTag, errorReportLevel: MsgKind = Warning, isLocalOnly = false): VersionTag =
+proc expandSpecial*(path: Path, vtag: VersionTag, errorReportLevel: MsgKind = Warning): VersionTag =
   if vtag.version.isHead():
-    return findOriginTip(path, errorReportLevel, isLocalOnly)
+    return findOriginTip(path, errorReportLevel, false)
 
   let (cc, status) = exec(GitRevParse, path, [vtag.version.string.substr(1)], errorReportLevel)
 
@@ -368,13 +369,6 @@ proc incrementLastTag*(path: Path, field: Natural): string =
 proc isShortCommitHash*(commit: string): bool {.inline.} =
   commit.len >= 4 and commit.len < 40
 
-proc updateRepo*(path: Path) =
-  let (outp, status) = exec(GitFetch, path, ["--tags"])
-  if status != RES_OK:
-    error(path, "could not update repo: " & outp)
-  else:
-    info(path, "successfully updated repo")
-
 proc getRemoteUrl*(path: Path): string =
   let (cc, status) = exec(GitRemoteUrl, path, [])
   if status != RES_OK:
@@ -383,9 +377,10 @@ proc getRemoteUrl*(path: Path): string =
   else:
     return cc.strip()
 
-proc isOutdated*(path: Path): bool =
+proc hasNewTags*(path: Path): Option[tuple[outdated: bool, newTags: int]] =
   ## determine if the given git repo `f` is updateable
-  ##
+  ## returns an option tuple with the outdated flag and the number of new tags
+  ## the option is none if the repo doesn't have remote url or remote tags
 
   info path, "checking is package is up to date..."
 
@@ -394,33 +389,36 @@ proc isOutdated*(path: Path): bool =
 
   let url = getRemoteUrl(path)
   if url.len == 0:
-    return false
+    return none(tuple[outdated: bool, newTags: int])
   let (remoteTagsList, lsStatus) = listRemoteTags(path, url)
   let remoteTags = remoteTagsList.toHashSet()
 
   if not lsStatus:
     warn path, "git list remote tags failed, skipping"
-    return false
+    return none(tuple[outdated: bool, newTags: int])
 
   if remoteTags > localTags:
     warn path, "got new versions:", $(remoteTags - localTags)
-    return true
+    return some((true, remoteTags.len() - localTags.len()))
+  elif remoteTags.len() == 0:
+    info path, "no local tags found, checking for new commits"
+    return none(tuple[outdated: bool, newTags: int])
 
-  return false
+  return some((false, 0))
 
-proc updateDir*(path: Path, filter: string) =
-  let (remote, _) = osproc.execCmdEx("git remote -v")
-  if filter.len == 0 or filter in remote:
-    let diff = checkGitDiffStatus(path)
-    if diff.len > 0:
-      warn($path, "has uncommitted changes; skipped")
+proc updateRepo*(path: Path, onlyTags = false) =
+  ## updates the repo by 
+  let url = getRemoteUrl(path)
+  if url.len == 0:
+    info path, "no remote URL found; cannot update"
+    return
+
+  let (outp, status) =
+    if onlyTags:
+      exec(GitFetch, path, ["--tags", "origin"])
     else:
-      let (branch, _) = exec(GitCurrentBranch, path, [])
-      if branch.strip.len > 0:
-        let (output, exitCode) = osproc.execCmdEx("git pull origin " & branch.strip)
-        if exitCode != 0:
-          error $path, output
-        else:
-          info($path, "successfully updated")
-      else:
-        error $path, "could not fetch current branch name"
+      exec(GitFetchAll, path, [])
+  if status != RES_OK:
+    error(path, "could not update repo: " & outp)
+  else:
+    notice(path, "successfully updated repo")

tests/tgitops.nim

@@ -1,5 +1,5 @@
 import unittest
-import std/[os, files, dirs, paths, osproc, strutils, uri]
+import std/[os, files, dirs, paths, osproc, strutils, uri, options]
 import basic/[reporters, osutils, versions, context]
 
 import basic/gitops
@@ -123,7 +123,7 @@ suite "Git Operations Tests":
       discard execCmd("git commit -m \"initial commit\"")
       check(incrementLastTag(Path ".", 0) == "v0.0.1")
 
-  test "isOutdated detection":
+  test "hasNewTags detection":
     withDir testDir:
       discard execCmd("git init")
       # Create initial commit and tag
@@ -138,10 +138,10 @@ suite "Git Operations Tests":
       discard execCmd("git commit -m \"update commit\"")
 
       # Test if repo is outdated
-      let outdated = isOutdated(Path ".")
+      let outdated = hasNewTags(Path ".")
       # Note: This might fail in isolated test environments
       # We're mainly testing the function structure
-      check(not outdated)  # Expected to be false in test environment
+      check(outdated.isNone)  # Expected to be false in test environment
 
   test "getRemoteUrl functionality":
     withDir testDir: