sbt.ivy.home and ivy.home properties both required

Steps

• Create a project for developing a plugin using the scripted plugin.
• Run sbt scripted with sbt.ivy.home pointing to custom location that is not ~/.ivy2

Problem

• When the tests run they pull dependencies from a location not specified by sbt.ivy.home, failing tests because they are unable to find the jars published during the publishLocal step

Expectations

• The publishLocal task will place the plugin jar in the location specified by sbt.ivy.home
• The scripted tasks will run and dependencies will be pulled from sbt.ivy.home

[a1kemist]

As @olafurpg points out, this makes it very difficult to run scripted tests in CI where you need to point to a custom ivy.home. Is there any workaround that someone has found?

This is what I tried to do for my situation:

export SBT_OPTS="-Dsbt.global.base=$CI_PROJECT_DIR/sbt-cache/.sbtboot -Dsbt.boot.directory=$CI_PROJECT_DIR/sbt-cache/.boot -Dsbt.ivy.home=$CI_PROJECT_DIR/.ivy"

Where CI_PROJECT_DIR is an env variable set by ci. Then in scripted.sbt I added the following (because apparently SBT_OPTS aren’t respected by the scripted task):

scriptedLaunchOpts := { scriptedLaunchOpts.value ++
    Seq("-Xmx1024M", "-Dplugin.version=" + version.value) ++
    // append SBT_OPTS so scripted launches with the correct cache dirs
    sys.env.get("SBT_OPTS").map(x => x.split(" ").toSeq).getOrElse(Nil)
}
scriptedBufferLog := false

This worked for most of the plugin projects I have been working on, but recently started failing again during a refactor.

After some investigation into that project, I found that the particular issue was due to scoping issues. Inspecting the value of scriptedLaunchOpts for the actual plugin project, revealed that it was missing my passthrough for SBT_OPTS. Adding those settings to my project specific settings made everything resolve properly after that.

I hope this helps someone else running into a similar issue with a custom sbt.ivy.home and running scripted tests for sbt plugins.

[kterusaki]

any update on this? As @a1kemist has pointed out, this the scripted plugin useless if we can’t run it in CICD where we need to point to a custom sbt.ivy.home.

I have the following as my scriptedLaunchOptions:

scriptedLaunchOpts := {
    scriptedLaunchOpts.value ++
      Seq("-Xmx1024M", "-Dplugin.version=" + version.value, "-Dsbt.ivy.home=" + sys.props.get("sbt.ivy.home"))
  }

And I’m passing the sbt.ivy.home system property to sbt like so:

sbt -Dsbt.ivy.home=$HOME/.ivy-custom/ scripted

The error output is:

....
	Note: Unresolved dependencies path:
[info] [error] sbt.librarymanagement.ResolveException: Error downloading my.org:my-project;sbtVersion=1.0;scalaVersion=2.12:5.0-SNAPSHOT
[info] [error]   Not found
[info] [error]   Not found
[info] [error]   not found: /private/var/folders/4x/8xntqh9d3310fgv5s6ncn1980000gp/T/sbt_5918511/Some/Users/me/.ivy-custom/local/my.org/my-project/scala_2.12/sbt_1.0/5.0-SNAPSHOT/ivys/ivy.xml

The sbt.ivy.home system property is treated as a relative URL to the tmp directory used to scope the sbt plugin test. I’m not sure what the right fix is here. If everything needs to be scoped by the /private/var/... directory then maybe the scripted plugin should copy the local snapshot to this folder?