Merge pull request #54 from isabelizimm/dev-docker-rsconnect

add local connect testing

Author: isabelizimm

.github/workflows/tests.yml

@@ -35,6 +35,32 @@ jobs:
           python -m pip install -e .[dev,torch]
       - name: Run Tests
         run: |
-          pytest --cov --cov-report xml .
+          pytest -m 'not rsc_test' --cov --cov-report xml
       - name: Upload coverage
         uses: codecov/codecov-action@v2
+
+  test-rsconnect:
+    name: "Test RSConnect"
+    runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.head.repo.fork }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .[dev,torch]
+      - name: run RStudio Connect
+        run: |
+          docker-compose up --build -d
+          make dev
+        env:
+          RSC_LICENSE: ${{ secrets.RSC_LICENSE }}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      # NOTE: edited to run checks for python package
+      - name: Run tests
+        run: |
+          pytest vetiver -m 'rsc_test'

Makefile

@@ -1,6 +1,12 @@
 .PHONY: clean-pyc clean-build clean docs
 UNAME := $(shell uname)
 
+SPHINX_BUILDARGS=
+# Note that these are keys generated by the docker rsconnect service, so are
+# not really secrets. They are saved to json to make it easy to use rsconnect
+# as multiple users from the tests
+RSC_API_KEYS=vetiver/tests/rsconnect_api_keys.json
+
 ifeq ($(UNAME), Darwin)
     BROWSER := open
 else
@@ -20,7 +26,9 @@ help:
 	@echo "release - package and upload a release"
 	@echo "dist - package"
 	@echo "install - install the package to the active Python's site-packages"
-	@echo "develop - install the package in development mode"
+	@echo "dev - generate RStudio Connect API keys"
+	@echo "dev-start - start up development RStudio Connect in Docker"
+	@echo "dev-stop - stop RStudio Connect dev container"
 
 clean: clean-build clean-pyc clean-test docs-clean
 
@@ -73,3 +81,19 @@ install: clean
 
 develop: clean-pyc
 	python setup.py develop
+
+dev: vetiver/tests/rsconnect_api_keys.json
+
+dev-start:
+	docker-compose up -d
+	docker-compose exec -T rsconnect bash < script/setup-rsconnect/add-users.sh
+	# curl fails with error 52 without a short sleep....
+	sleep 5
+	curl -s --retry 10 --retry-connrefused http://localhost:3939
+
+dev-stop:
+	docker-compose down
+	rm -f $(RSC_API_KEYS)
+
+$(RSC_API_KEYS): dev-start
+	python script/setup-rsconnect/dump_api_keys.py $@

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3.1'
+
+services:
+
+  rsconnect:
+    image: rstudio/rstudio-connect:2021.12.1
+    restart: always
+    ports:
+      - 3939:3939
+    volumes:
+      - $PWD/script/setup-rsconnect/users.txt:/etc/users.txt
+      - $PWD/script/setup-rsconnect/rstudio-connect.gcfg:/etc/rstudio-connect/rstudio-connect.gcfg
+    # by default, mysql rounds to 4 decimals, but tests require more precision
+    privileged: true
+    environment:
+      RSTUDIO_CONNECT_HASTE: "enabled"
+      RSC_LICENSE: ${RSC_LICENSE}

pyproject.toml

@@ -1,3 +1,11 @@
 [build-system]
 requires = ["setuptools>=45", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+testpaths = ["vetiver"]
+addopts = "--doctest-modules"
+doctest_optionflags = "NORMALIZE_WHITESPACE"
+markers = [
+    "rsc_test: tests for rstudio connect",
+]

script/setup-rsconnect/add-users.sh

@@ -0,0 +1 @@
+awk ' { system("useradd -m -s /bin/bash "$1); system("echo \""$1":"$2"\" | chpasswd"); system("id "$1) } ' /etc/users.txt

script/setup-rsconnect/dump_api_keys.py

@@ -0,0 +1,21 @@
+import json
+import sys
+
+from pins.rsconnect.api import _HackyConnect
+
+OUT_FILE = sys.argv[1]
+
+
+def get_api_key(user, password, email):
+    rsc = _HackyConnect("http://localhost:3939")
+
+    return rsc.create_first_admin(user, password, email).api_key
+
+
+api_keys = {
+    "admin": get_api_key("admin", "admin0", "admin@example.com"),
+    "susan": get_api_key("susan", "susan", "susan@example.com"),
+    "derek": get_api_key("derek", "derek", "derek@example.com"),
+}
+
+json.dump(api_keys, open(OUT_FILE, "w"))

script/setup-rsconnect/rstudio-connect.gcfg

@@ -0,0 +1,21 @@
+[Server]
+DataDir = /data
+Address = http://localhost:3939
+
+[HTTP]
+Listen = :3939
+
+[Authentication]
+Provider = pam
+
+[Authorization]
+DefaultUserRole = publisher
+
+[Python]
+Enabled = false
+
+[RPackageRepository "CRAN"]
+URL = https://packagemanager.rstudio.com/cran/__linux__/bionic/latest
+
+[RPackageRepository "RSPM"]
+URL = https://packagemanager.rstudio.com/cran/__linux__/bionic/latest

script/setup-rsconnect/users.txt

@@ -0,0 +1,4 @@
+admin admin0
+test  test
+susan susan
+derek derek

vetiver/tests/rsconnect_api_keys.json

@@ -0,0 +1 @@
+{"admin": "iv6yzMB4GwhQIXjI3lOWG2T21N02C9SU", "susan": "llQqii6bHqV5R9eMN7qpTvJqr3xtnRmy", "derek": "FkakZvdVk2ApxDVkbEn6u2g0eSul4tE6"}

vetiver/tests/test_rsconnect.py

@@ -0,0 +1,54 @@
+import pytest
+import json
+from pins.rsconnect.fs import RsConnectFs
+from pins.boards import BoardRsConnect
+
+RSC_SERVER_URL = "http://localhost:3939"
+RSC_KEYS_FNAME = "vetiver/tests/rsconnect_api_keys.json"
+
+pytestmark = pytest.mark.rsc_test  # noqa
+
+def rsc_from_key(name):
+    from pins.rsconnect.api import RsConnectApi
+
+    with open(RSC_KEYS_FNAME) as f:
+        api_key = json.load(f)[name]
+        return RsConnectApi(RSC_SERVER_URL, api_key)
+
+def rsc_fs_from_key(name):
+    from pins.rsconnect.fs import RsConnectFs
+
+    rsc = rsc_from_key(name)
+
+    return RsConnectFs(rsc)
+
+
+def rsc_delete_user_content(rsc):
+    guid = rsc.get_user()["guid"]
+    content = rsc.get_content(owner_guid=guid)
+    for entry in content:
+        rsc.delete_content_item(entry["guid"])
+
+@pytest.fixture(scope="function")
+def rsc_short():
+    # tears down content after each test
+    fs_susan = rsc_fs_from_key("susan")
+
+    # delete any content that might already exist
+    rsc_delete_user_content(fs_susan.api)
+
+    yield BoardRsConnect("", fs_susan, allow_pickle_read=True) #fs_susan.ls to list content
+
+    rsc_delete_user_content(fs_susan.api)
+
+from vetiver import VetiverModel, vetiver_pin_write, mock
+import sklearn
+# Load data, model
+X_df, y = mock.get_mock_data()
+model = mock.get_mock_model().fit(X_df, y)
+
+def test_board_pin_write(rsc_short):
+    v = VetiverModel(model=model, ptype_data=X_df,
+        model_name="susan/model", versioned=None)
+    vetiver_pin_write(board=rsc_short, model=v)
+    assert isinstance(rsc_short.pin_read("susan/model"), sklearn.dummy.DummyRegressor)