Fix tests

- Add a Mercurial install step to the CI on Mac OS because it is not
  installed by default but it is required by the `vcstools.nim` module
  tests.

- Add workaround for the `Resource temporarily unavailable (code: 11)`
  error on Linux systems. The error is most probably caused by a bug in
  the `asynctools` or the Nim standard library but currently, the
  workaround is an easier solution than a proper fix.

- Add debug priority printing of the command to be executed by the
  `doCmdEx` and` doCmdExAsync` procedures.

- Fix `vcstools.getBranchesOnWhichVcsRevisionIsPresent` procedure which
  had a wrong output on Windows.

- Configure user name and email for the local testing repositories to
  avoid VCS operations failure when tests are executed on the CI.

- Fix expected character for root directory in
  `getVcsTypeAndSpecialDirPath` test in` vcstools.nim` module.

- Use a proper module name in the `dependency.nim` test file when the
  tests are executed on Mac OS.

- Fix the expected main repository path on Mac OS to start with
  "/private" in "cannot lock because develop dependency is out of range"
  test in `tlockfile.nim`.

Most probably the list is incomplete because I'm missing something. :)

Related to #127

Author: bobeff

.github/workflows/test.yml

@@ -24,6 +24,9 @@ jobs:
         with:
           version: ${{ matrix.nimversion }}
       - run: nim --version
+      - name: Install Mercurial on macOS
+        if: matrix.os == 'macos-latest'
+        run: brew install mercurial
       - name: Run nim c -r tester
         run: |
           cd tests

src/nimblepkg/asynctools/asyncproc.nim

@@ -24,9 +24,6 @@ else:
   const STILL_ACTIVE = 259
   import posix
 
-when defined(linux):
-  import linux
-
 type
   ProcessOption* = enum  ## options that can be passed `startProcess`
     poEchoCmd,            ## echo the command before execution
@@ -510,7 +507,7 @@ else:
     result = cast[cstringArray](alloc0((counter + 1) * sizeof(cstring)))
     var i = 0
     for key, val in envPairs():
-      var x = key.string & "=" & val.string
+      var x = key & "=" & val
       result[i] = cast[cstring](alloc(x.len+1))
       copyMem(result[i], addr(x[0]), x.len+1)
       inc(i)
@@ -889,7 +886,17 @@ proc execProcess(command: string, args: seq[string] = @[],
   var data = newString(bufferSize)
   var p = startProcess(command, args = args, env = env, options = options)
 
-  let future = p.waitForExit()
+  # Here the code path for Linux systems is a workaround for a bug eighter in
+  # the `asynctools` library or the Nim standard library which causes `Resource
+  # temporarily unavailable (code: 11)` error when executing multiple
+  # asynchronous operations.
+  #
+  # TODO: Add a proper fix that does not use a different code ordering on the
+  # different systems.
+
+  when not defined(linux):
+    let future = p.waitForExit
+
   while true:
     let res = await p.outputHandle.readInto(addr data[0], bufferSize)
     if res > 0:
@@ -898,12 +905,16 @@ proc execProcess(command: string, args: seq[string] = @[],
       data.setLen(bufferSize)
     else:
       break
-  result.exitcode = await future
+
+  result.exitcode =
+    when not defined(linux):
+      await future
+    else:
+      await p.waitForExit
+
   close(p)
 
 when isMainModule:
-  import os
-
   when defined(windows):
     var data = waitFor(execProcess("cd"))
   else:

src/nimblepkg/tools.nim

@@ -47,6 +47,7 @@ proc doCmd*(cmd: string) =
         [$exitCode, cmd, output])
 
 proc doCmdEx*(cmd: string): ProcessOutput =
+  displayDebug("Executing", cmd)
   let bin = extractBin(cmd)
   if findExe(bin) == "":
     raise nimbleError("'" & bin & "' not in PATH.")
@@ -57,6 +58,7 @@ proc removeQuotes(cmd: string): string =
 
 proc doCmdExAsync*(cmd: string, args: seq[string] = @[]):
     Future[ProcessOutput] {.async.} =
+  displayDebug("Executing", join(concat(@[cmd], args), " "))
   let bin = extractBin(cmd)
   if findExe(bin) == "":
     raise nimbleError("'" & bin & "' not in PATH.")

src/nimblepkg/vcstools.nim

@@ -410,14 +410,15 @@ proc getBranchesOnWhichVcsRevisionIsPresent*(
 
   let vcsType = path.getVcsType
   for line in output.strip.splitLines:
-    var line = line.strip(chars = Whitespace + {'*'})
+    var line = line.strip(chars = Whitespace + {'*', '\''})
     if vcsType == vcsTypeGit and branchType == btBoth:
       # For "git branch -a" remote branches are starting with "remotes" which
       # have to be removed for uniformity with "git branch -r".
       const prefix = "remotes/"
       if line.startsWith(prefix):
         line = line[prefix.len .. ^1]
-    result.incl line
+    if line.len > 0:
+      result.incl line
 
 proc isVcsRevisionPresentOnSomeBranch*(path: Path, vcsRevision: Sha1Hash):
     bool =
@@ -624,7 +625,7 @@ proc fastForwardMerge*(path: Path, remoteBranch, localBranch: string) =
     tryDoCmdEx(&"{git(path)} checkout {currentBranch}")
 
 when isMainModule:
-  import unittest, std/sha1, sequtils, os
+  import unittest, std/sha1, sequtils
 
   type
     NameToVcsRevision = OrderedTable[string, Sha1Hash]
@@ -635,11 +636,11 @@ when isMainModule:
     testGitDir = tempDir / "testGitDir"
     testHgDir = tempDir / "testHgDir"
     testNoVcsDir = tempDir / "testNoVcsDir"
-    testSubDir = "./testSubDir"
+    testSubDir = "testSubDir"
     testFile = "test.txt"
     testFile2 = "test2.txt"
     testFileContent = "This is a test file.\n"
-    testSubDirFile = testSubDir / testFile
+    testSubDirFile = &"{testSubDir}/{testFile}"
     testRemotes: seq[tuple[name, url: string]] = @[
       ("origin", "testRemote1Dir"),
       ("other", "testRemote2Dir"),
@@ -654,12 +655,20 @@ when isMainModule:
 
   var nameToVcsRevision: NameToVcsRevision
 
-  proc getMercurialPathsDesc(): string =
-    result = "[paths]\n"
+  proc getMercurialRcFileContent(): string =
+    result = """
+[ui]
+username = John Doe <[email protected]>
+[paths]
+"""
     for remote in testRemotes:
-      result &= &"{remote.name} = {remote.url.absolutePath}\n"
+      result &= &"{remote.name} = {testHgDir / remote.url}\n"
 
-  proc initRepo(vcsType: VcsType) = tryDoCmdEx(&"{vcsType} init")
+  proc initRepo(vcsType: VcsType, url = ".") =
+    tryDoCmdEx(&"{vcsType} init {url}")
+    if vcsType == vcsTypeGit:
+      tryDoCmdEx(&"git -C {url} config user.name \"John Doe\"")
+      tryDoCmdEx(&"git -C {url} config user.email \"[email protected]\"")
 
   proc collectFiles(files: varargs[string]): string =
     for file in files: result &= file & " "
@@ -688,13 +697,13 @@ when isMainModule:
       for remote in testRemotes:
         tryDoCmdEx(&"git remote add {remote.name} {remote.url}")
     of vcsTypeHg:
-      writeFile(".hg/hgrc", getMercurialPathsDesc())
+      writeFile(".hg/hgrc", getMercurialRcFileContent())
     of vcsTypeNone:
       assert false, "VCS type must not be 'vcsTypeNone'."
 
   proc setupRemoteRepo(vcsType: VcsType, remoteUrl: string) =
     createDir remoteUrl
-    tryDoCmdEx(&"{vcsType} init {remoteUrl}")
+    initRepo(vcsType, remoteUrl)
     if vcsType == vcsTypeGit:
       cd remoteUrl:
         tryDoCmdEx("git config receive.denyCurrentBranch ignore")
@@ -726,6 +735,9 @@ when isMainModule:
     tryDoCmdEx(&"{vcsType} branch {branchName}")
 
   proc pushToRemote(vcsType: VcsType, remoteName: string) =
+    if vcsType == vcsTypeGit and remoteName == gitDefaultRemote:
+      let branchName = getCurrentBranch(".")
+      tryDoCmdEx(&"git push --set-upstream {remoteName} {branchName}")
     tryDoCmdEx(&"{vcsType} push {remoteName}")
 
   proc pushToTestRemotes(vcsType: VcsType) =
@@ -1033,13 +1045,13 @@ when isMainModule:
 
   suite "Mercurial":
     suiteTestCode(vcsTypeHg, testHgDir):
-      (testHgDir / remote.url).absolutePath
+      testHgDir / remote.url
 
   suite "no version control":
     setupNoVcsSuite()
 
     test "getVcsTypeAndSpecialDirPath":
-      const rootDir = when defined(windows): '\\' else: '/'
+      const rootDir = when defined(windows): ':' else: '/'
       let (vcsType, specialDirPath) = getVcsTypeAndSpecialDirPath(testNoVcsDir)
       check vcsType == vcsTypeNone
       check ($specialDirPath)[^1] == rootDir
@@ -1048,6 +1060,7 @@ when isMainModule:
       check not isValidSha1Hash($getVcsRevision(testNoVcsDir))
 
     test "getPackageFileList":
-      check getPackageFileList(testNoVcsDir) == @[testFile, testSubDirFile]
+      check getPackageFileList(testNoVcsDir) ==
+            @[testFile, testSubDirFile.normalizedPath]
 
     tearDownSuite(testNoVcsDir)

tests/develop/dependency/dependency.nim

@@ -1,7 +1,7 @@
 import packagea
 
 proc test*(): string =
-  when defined(windows):
+  when defined(windows) or defined(macosx):
     $PackageA.test(6, 9)
   elif defined(unix):
     $packagea.test(6, 9)

tests/tester.nim

@@ -1,7 +1,10 @@
 # Copyright (C) Dominik Picheta. All rights reserved.
 # BSD License. Look at license.txt for more info.
 
-# import suites
+import testscommon
+
+# suits imports
+
 import tcheckcommand
 import tdevelopfeature
 import tissues

tests/testscommon.nim

@@ -1,6 +1,8 @@
 # Copyright (C) Dominik Picheta. All rights reserved.
 # BSD License. Look at license.txt for more info.
 
+{.used.}
+
 import sequtils, strutils, strformat, os, osproc, sugar, unittest, macros,
        std/sha1
 

tests/tlockfile.nim

@@ -119,12 +119,18 @@ requires "nim >= 1.5.1"
   proc addRemote(remoteName, remoteUrl: string) =
     tryDoCmdEx(&"git remote add {remoteName} {remoteUrl}")
 
+  proc configUserAndEmail =
+    tryDoCmdEx("git config user.name \"John Doe\"")
+    tryDoCmdEx("git config user.email \"[email protected]\"")
+
   proc initRepo(isBare = false) =
     let bare = if isBare: "--bare" else: ""
     tryDoCmdEx("git init " & bare)
+    configUserAndEmail()
 
   proc clone(urlFrom, pathTo: string) =
     tryDoCmdEx(&"git clone {urlFrom} {pathTo}")
+    cd pathTo: configUserAndEmail()
 
   proc branch(branchName: string) =
     tryDoCmdEx(&"git branch {branchName}")
@@ -183,7 +189,7 @@ requires "nim >= 1.5.1"
     else:
       check fileExists(lockFileName)
 
-    let (output, exitCode) = execNimbleYes("lock")
+    let (output, exitCode) = execNimbleYes("lock", "--debug")
     check exitCode == QuitSuccess
 
     var lines = output.processOutput
@@ -245,6 +251,13 @@ requires "nim >= 1.5.1"
 
         let (output, exitCode) = execNimbleYes("lock")
         check exitCode == QuitFailure
+        let mainPkgRepoPath =
+          when defined(macosx):
+            # This is a workaround for the added `/private` prefix to the main
+            # repository Nimble file path when executing the test on macOS.
+            "/private" / mainPkgRepoPath
+          else:
+            mainPkgRepoPath
         let errors = @[
           notInRequiredRangeMsg(dep1PkgName, dep1PkgRepoPath, "0.1.0",
                                 mainPkgName, mainPkgRepoPath, "> 0.1.0"),
@@ -266,7 +279,7 @@ requires "nim >= 1.5.1"
                        (dep2PkgName, dep2PkgRepoPath)],
                      isNew = true)
         removeDir installDir
-        let (output, exitCode) = execNimbleYes("install")
+        let (output, exitCode) = execNimbleYes("install", "--debug")
         check exitCode == QuitSuccess
         let lines = output.processOutput
         check lines.inLines(&"Downloading {dep1PkgOriginRepoPath} using git")