Merge pull request #253 from Philippus/keep-credentials-option

Add option to keep credentials for updating private dependencies

Author: fthomas

modules/core/src/main/scala/org/scalasteward/core/application/Cli.scala

@@ -37,7 +37,8 @@ object Cli {
       whitelist: List[String] = Nil,
       readOnly: List[String] = Nil,
       disableSandbox: Boolean = false,
-      doNotFork: Boolean = false
+      doNotFork: Boolean = false,
+      keepCredentials: Boolean = false
   )
 
   def create[F[_]](implicit F: ApplicativeThrowable[F]): Cli[F] = new Cli[F] {

modules/core/src/main/scala/org/scalasteward/core/application/Config.scala

@@ -54,7 +54,8 @@ final case class Config(
     whitelistedDirectories: List[String],
     readOnlyDirectories: List[String],
     disableSandbox: Boolean,
-    doNotFork: Boolean
+    doNotFork: Boolean,
+    keepCredentials: Boolean
 ) {
   def gitHubUser[F[_]](implicit F: Sync[F]): F[AuthenticatedUser] =
     util.uri.fromString[F](gitHubApiHost).flatMap { url =>
@@ -81,7 +82,8 @@ object Config {
         whitelistedDirectories = args.whitelist,
         readOnlyDirectories = args.readOnly,
         disableSandbox = args.disableSandbox,
-        doNotFork = args.doNotFork
+        doNotFork = args.doNotFork,
+        keepCredentials = args.keepCredentials
       )
     }
 }

modules/core/src/main/scala/org/scalasteward/core/sbt/SbtAlg.scala

@@ -20,6 +20,7 @@ import better.files.File
 import cats.Monad
 import cats.implicits._
 import io.chrisdavenport.log4cats.Logger
+import org.scalasteward.core.application.Config
 import org.scalasteward.core.dependency.Dependency
 import org.scalasteward.core.dependency.parser.parseDependencies
 import org.scalasteward.core.github.data.Repo
@@ -44,6 +45,7 @@ trait SbtAlg[F[_]] {
 object SbtAlg {
   def create[F[_]](
       implicit
+      config: Config,
       fileAlg: FileAlg[F],
       logger: Logger[F],
       processAlg: ProcessAlg[F],
@@ -85,7 +87,12 @@ object SbtAlg {
       override def getUpdatesForRepo(repo: Repo): F[List[Update.Single]] =
         for {
           repoDir <- workspaceAlg.repoDir(repo)
-          cmd = sbtCmd(setCredentialsToNil, dependencyUpdates, reloadPlugins, dependencyUpdates)
+          cmd = {
+            if (config.keepCredentials)
+              sbtCmd(dependencyUpdates, reloadPlugins, dependencyUpdates)
+            else
+              sbtCmd(setCredentialsToNil, dependencyUpdates, reloadPlugins, dependencyUpdates)
+          }
           lines <- exec(cmd, repoDir)
         } yield parser.parseSingleUpdates(lines)
 

modules/core/src/test/scala/org/scalasteward/core/mock/MockContext.scala

@@ -19,7 +19,8 @@ object MockContext {
     whitelistedDirectories = Nil,
     readOnlyDirectories = Nil,
     disableSandbox = false,
-    doNotFork = false
+    doNotFork = false,
+    keepCredentials = false
   )
 
   implicit val fileAlg: MockFileAlg = new MockFileAlg

modules/core/src/test/scala/org/scalasteward/core/sbt/SbtAlgTest.scala

@@ -1,9 +1,10 @@
 package org.scalasteward.core.sbt
 
 import better.files.File
+import org.scalasteward.core.application.Config
 import org.scalasteward.core.github.data.Repo
-import org.scalasteward.core.mock.MockContext.sbtAlg
-import org.scalasteward.core.mock.MockState
+import org.scalasteward.core.mock.MockContext._
+import org.scalasteward.core.mock.{MockContext, MockState}
 import org.scalatest.{FunSuite, Matchers}
 
 class SbtAlgTest extends FunSuite with Matchers {
@@ -47,4 +48,29 @@ class SbtAlgTest extends FunSuite with Matchers {
       )
     )
   }
+
+  test("getUpdatesForRepo keeping credentials") {
+    val repo = Repo("fthomas", "refined")
+    implicit val config: Config = MockContext.config.copy(keepCredentials = true)
+    val sbtAlgKeepingCredentials = SbtAlg.create
+    val state =
+      sbtAlgKeepingCredentials.getUpdatesForRepo(repo).runS(MockState.empty).unsafeRunSync()
+
+    state shouldBe MockState.empty.copy(
+      commands = Vector(
+        List("rm", "/tmp/ws/fthomas/refined/.jvmopts"),
+        List("rm", "/tmp/ws/fthomas/refined/.sbtopts"),
+        List(
+          "firejail",
+          "--whitelist=/tmp/ws/fthomas/refined",
+          "sbt",
+          "-batch",
+          "-no-colors",
+          ";dependencyUpdates;reload plugins;dependencyUpdates"
+        ),
+        List("restore", "/tmp/ws/fthomas/refined/.sbtopts"),
+        List("restore", "/tmp/ws/fthomas/refined/.jvmopts")
+      )
+    )
+  }
 }