Add tests for virtualenv

Author: kiendang

.github/workflows/ci.yml

@@ -31,5 +31,7 @@ jobs:
         run: sbt +test
         shell: bash
       - name: Integration tests again latest ScalaPy stable
-        run: .github/scripts/integration_test.sh python3 0.5.0
+        run: scripts/integration_test.sh python3 0.5.0
         shell: bash
+      - name: Test virtualenv
+        run: scripts/virtualenv_test.sh 0.5.0+8-7c7a6042

.gitignore

@@ -5,5 +5,8 @@ target/
 .bsp/
 .bloop/
 
+__pycache__/
+.ipynb_checkpoints/
+
 .DS_Store
 *.worksheet.sc

build.sbt

@@ -20,7 +20,9 @@ lazy val scala212 = "2.12.14"
 lazy val scala213 = "2.13.6"
 lazy val scala3   = "3.0.0"
 
-lazy val enableScripted = Option(sys.props("plugin.ci")).map(_.trim.nonEmpty).getOrElse(false)
+lazy val scalapyVersion = getProp("plugin.scalapy.version").getOrElse("0.5.0")
+
+lazy val enableScripted = getProp("plugin.ci").isDefined
 
 ThisBuild / scalaVersion := (if (enableScripted) scala212 else scala213)
 
@@ -32,25 +34,28 @@ def warnUnusedImports(scalaVersion: String) =
     case _            => Nil
   }
 
+def getProp(p: String) = Option(sys.props(p)).map(_.trim).filter(_.nonEmpty)
+
+def getProps(prop: String*) =
+  prop
+    .map(p => p -> getProp(p))
+    .collect { case (k, Some(v)) => s"""-D$k=$v""" }
+
 def scriptedPlugin = if (enableScripted) Seq(ScriptedPlugin) else Nil
 
 def scriptedSettings = if (enableScripted) {
   Seq(
     scriptedLaunchOpts := {
       scriptedLaunchOpts.value ++ {
         Seq(s"-Dplugin.scalapy.version=$scalapyVersion") ++
-          Option(sys.props("plugin.python.executable"))
-            .map("-Dplugin.python.executable=" + _)
-            .toSeq ++
+          getProps("plugin.python.executable", "plugin.virtualenv") ++
           Seq("-Xmx1024M", "-Dplugin.version=" + version.value)
       }
     },
     scriptedBufferLog := false
   )
 } else Nil
 
-lazy val scalapyVersion = Option(sys.props("plugin.scalapy.version")).map(_.trim).getOrElse("0.5.0")
-
 lazy val root = (project in file("."))
   .enablePlugins(scriptedPlugin: _*)
   .settings(

examples/python-package/dummy/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

examples/python-package/setup.cfg

@@ -0,0 +1,6 @@
+[metadata]
+name = dummy
+version = attr: dummy.__version__
+
+[options]
+packages = find:

examples/python-package/setup.py

@@ -0,0 +1,2 @@
+import setuptools
+setuptools.setup()

.github/scripts/integration_test.sh renamed to scripts/integration_test.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+VENV_DIR=$(mktemp -d)
+
+echo "Virtualenv created at ${VENV_DIR}"
+
+python3 -m venv "${VENV_DIR}"
+"${VENV_DIR}"/bin/python -m pip install examples/python-package
+
+sbt +publishLocal
+
+sbt \
+  -Dplugin.ci=true \
+  -Dplugin.virtualenv=true \
+  -Dplugin.python.executable="${VENV_DIR}/bin/python" \
+  -Dplugin.scalapy.version="$1" \
+  scripted
+
+echo "Delete virtualenv ${VENV_DIR}"
+rm -r "${VENV_DIR}"

scripts/virtualenv_test.sh

@@ -6,27 +6,38 @@ lazy val scala3   = "3.0.0"
 
 ThisBuild / scalaVersion := scala213
 
-lazy val scalapyVersion = sys.props("plugin.scalapy.version")
+def getProp(p: String) = Option(sys.props(p)).map(_.trim).filter(_.nonEmpty)
 
-lazy val python = Python(
-  Option(sys.props("plugin.python.executable")).filter(_.trim.nonEmpty)
-)
+def getProps(prop: String*) =
+  prop
+    .map(p => p -> getProp(p))
+    .collect { case (k, Some(v)) => s"""-D$k=$v""" }
+
+lazy val scalapyVersion = getProp("plugin.scalapy.version").get
+
+lazy val python = Python(getProp("plugin.python.executable"))
 
 lazy val pythonLdFlags = python.ldflags.get
 
 lazy val javaOpts = python.scalapyProperties.get.map { case (k, v) =>
   s"""-D$k=$v"""
 }.toSeq
 
+val checkModule = taskKey[Unit]("Check loading a dummy module")
+
 lazy val root = crossProject(JVMPlatform, NativePlatform)
   .in(file("."))
   .settings(
-    crossScalaVersions := Seq(scala212, scala213)
+    crossScalaVersions := Seq(scala212, scala213),
+    Compile / mainClass := Some("project.Main")
   )
   .jvmSettings(
     fork := true,
-    javaOptions ++= javaOpts,
-    libraryDependencies += "me.shadaj" %% "scalapy-core" % scalapyVersion
+    javaOptions ++= javaOpts ++ getProps("plugin.virtualenv"),
+    libraryDependencies += "me.shadaj" %% "scalapy-core" % scalapyVersion,
+    checkModule := {
+      (Compile / runMain).toTask(" project.Module").value
+    }
   )
   .nativeSettings(
     libraryDependencies += "me.shadaj" %%% "scalapy-core" % scalapyVersion,

src/sbt-test/integration/scalapy/build.sbt

@@ -0,0 +1,12 @@
+package project
+
+import me.shadaj.scalapy.py
+import me.shadaj.scalapy.py.{PyQuote, SeqConverters}
+
+object Module {
+  def main(args: Array[String]): Unit = {
+    Option(sys.props("plugin.virtualenv")).map(_.trim).filter(_.nonEmpty).foreach { _ =>
+      println(s"Successfully load ${py.module("dummy")}")
+    }
+  }
+}

src/sbt-test/integration/scalapy/jvm/src/main/scala/project/Module.scala

@@ -5,7 +5,7 @@ import me.shadaj.scalapy.py.{PyQuote, SeqConverters}
 
 object Main {
   def main(args: Array[String]): Unit = {
-    println(py.Dynamic.global.list(Seq(1, 2, 3).toPythonProxy))
+    println(py.Dynamic.global.list(Seq(1, 2, 3).toPythonCopy))
     println(py"'Hello from ScalaPy!'")
   }
 }

src/sbt-test/integration/scalapy/shared/src/main/scala/project/Main.scala

@@ -1,2 +1,3 @@
 > +rootJVM/run
 > +rootNative/run
+> +rootJVM/checkModule