2.18 wip

.circleci/config.yml

@@ -6,6 +6,7 @@ orbs:
   win: circleci/[email protected]
   # Upload artifacts to s3
   aws-s3: circleci/[email protected]
+  codecov: codecov/[email protected]
 
 jobs:
 
@@ -94,7 +95,50 @@ jobs:
           root: ./
           paths:
             - zip_build
-
+
+  test:
+    machine:
+      image: ubuntu-2204:2023.02.1
+      docker_layer_caching: false
+    resource_class: medium
+    parameters:
+      tag:
+        default: "3.11"
+        type: string
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ./
+      - run:
+          name: Install python
+          command: |
+            pyenv install -s << parameters.tag >>
+            pyenv global << parameters.tag >>
+      - run:
+          name: Startup the Speckle Server
+          command: docker compose -f docker-compose.yml up -d
+      - run:
+          name: Install Poetry
+          command: |
+            pip install poetry
+      - run:
+          name: Install packages
+          command: |
+            poetry lock --no-update
+            poetry install
+      - run:
+          name: Remove qgis tests
+          command: |
+            rm -rf ./tests_qgis
+      - run:
+          name: Run tests
+          command: poetry run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
+      - store_test_results:
+          path: reports
+      - store_artifacts:
+          path: reports
+      - codecov/upload
+
   build-connector-win: # Reusable job for basic connectors
     executor:
       name: win/default # comes with python 3.7.3
@@ -228,7 +272,23 @@ jobs:
               -o << parameters.os >> \
               -a << parameters.arch >> \
               -f speckle-sharp-ci-tools/Installers/qgis/<< parameters.slug >>-${SEMVER}.<< parameters.extension >>
-workflows: #happens with every PR to main
+workflows: # happens with every PR to main
+  test_on_pr: # build the installers, but don't persist to workspace for deployment
+    jobs:
+      - get-ui:
+          context: github-dev-bot
+      - get-ci-tools:
+          context: github-dev-bot
+      - package:
+          requires:
+            - get-ui
+            - get-ci-tools 
+      - test:
+          requires:
+            - package
+          matrix:
+            parameters:
+              tag: ["3.11"]
   build: # build the installers, but don't persist to workspace for deployment
     jobs:
       - get-ui:
@@ -246,9 +306,16 @@ workflows: #happens with every PR to main
             - get-ui
             - get-ci-tools 
           filters: *build_filters
-      - build-connector-win:
+      - test:
           requires:
             - package
+          matrix:
+            parameters:
+              tag: ["3.11"]
+          filters: *build_filters
+      - build-connector-win:
+          requires:
+            - test
           filters: *build_filters
           context: innosetup
 
@@ -257,7 +324,6 @@ workflows: #happens with every PR to main
           slug: qgis-mac-arm
           runtime: osx-arm64
           requires:
-            - package
             - build-connector-win
           filters: *build_filters
 
@@ -266,11 +332,10 @@ workflows: #happens with every PR to main
           slug: qgis-mac-intel
           runtime: osx-x64
           requires:
-            - package
             - build-connector-win
           filters: *build_filters
 
-  deploy: # build installers and deploy
+  deploy: # build installers and deploy 
     jobs:
       - get-ui:
           context: github-dev-bot
@@ -295,11 +360,22 @@ workflows: #happens with every PR to main
           requires:
             - get-ui
             - get-ci-tools 
+      - test:
+          requires:
+            - package
+          matrix:
+            parameters:
+              tag: ["3.11"]
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/
       - build-connector-win:
           slug: qgis
           installer: true
           requires:
-            - package
+            - test
           filters: &deploy_filters
             tags:
               only: /([0-9]+)\.([0-9]+)\.([0-9]+)(?:-\w+)?$/

.gitignore

@@ -1,5 +1,4 @@
 ./idea/
-/.vscode/
 /speckle_qgis_dialog_base.ui.autosave
 
 # Byte-compiled / optimized / DLL files
@@ -118,6 +117,9 @@ zip_build
 .qt_for_python
 speckle-sharp-ci-tools*
 zip-build*
+*.dbf
+*.shp
+*.shx 
 
 /typings/*
 *.csv

.vscode/launch.json

@@ -0,0 +1,39 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "pytest",
+            "type": "python",
+            "request": "launch",
+            "module": "pytest",
+            "justMyCode": true
+        },
+        {
+            "name": "Python: Current File",
+            "type": "python",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": false,
+            "env": {
+                "PYTHONPATH": "C:/Users/katri/AppData/Roaming/Python/Python39"
+            }
+        },
+        {
+            "name": "Python: Remote Attach",
+            "type": "python",
+            "request": "attach",
+            "port": 5678,
+            "host": "localhost",
+            "pathMappings": [
+                {
+                    "localRoot": "${workspaceFolder}",
+                    "remoteRoot": "${workspaceFolder}"
+                }
+            ]
+        }
+    ]
+}

README.md

@@ -56,13 +56,19 @@ This repo contains the QGIS plugin for Speckle 2.0. It is written in `python` an
 > The following geometry types are supported for now:
 >
 > - Point
-> - Multipoint
+> - MultiPoint
 > - Polyline (LineString)
 > - MultiLineString
 > - Polygon
 > - MultiPolygon
 > - **More to come!!**
 >
+> Data types currently not supported for sending:
+> - Layers depending on the server connection (WMS, WFC, WCS etc.) 
+> - Scenes 
+> - Mesh Vector layers 
+> - Pointclouds 
+>
 > If you have questions, you can always find us at our [Community forum](https://speckle.community)
 
 ## Installation
@@ -140,7 +146,7 @@ YOUR_PYTHON_EXECUTABLE -m pip install pb_tool
 
 For a better development experience in your editor, we recommend creating a virtual environment. In the venv, you'll just need to install `specklepy`. You will also need to copy over the `qgis` module into the `{venv}/Lib/site-packages`. You can find the `qgis` module in your QGIS install directory:
 
-- Windows: `C:\Program Files\QGIS 3.20.1\apps\qgis\python`
+- Windows: `C:\Program Files\QGIS 3.28.15\apps\qgis\python`
 - MacOS: `/Applications/QGIS.app/Contents/Resources/python`
 
 ![qgis dependency for venv](https://user-images.githubusercontent.com/7717434/129324330-1744cc1e-8657-4ef1-90eb-d1ffb2b0229e.png)

__init__.py

@@ -7,49 +7,49 @@
 if path not in sys.path:
     sys.path.insert(0, path)
 
-from plugin_utils.installer import ensure_dependencies, startDebugger
-from speckle.utils.panel_logging import logger
+try:
+    from plugin_utils.installer import ensure_dependencies, startDebugger
+    from speckle.utils.panel_logging import logger
 
-from qgis.core import Qgis
+    from qgis.core import Qgis
 
+    # noinspection PyPep8Naming
+    def classFactory(iface):  # pylint: disable=invalid-name
+        """Load SpeckleQGIS class from file SpeckleQGIS.
 
-# noinspection PyPep8Naming
-def classFactory(iface):  # pylint: disable=invalid-name
-    """Load SpeckleQGIS class from file SpeckleQGIS.
+        :param iface: A QGIS interface instance.
+        :type iface: QgsInterface
+        """
 
-    :param iface: A QGIS interface instance.
-    :type iface: QgsInterface
-    """
+        # Set qgisInterface to enable logToUser notifications
+        logger.qgisInterface = iface
+        iface.pluginToolBar().setVisible(True)
 
-    # Set qgisInterface to enable logToUser notifications
-    logger.qgisInterface = iface
-    iface.pluginToolBar().setVisible(True)
+        # Ensure dependencies are installed in the machine
+        startDebugger()
+        ensure_dependencies("QGIS")
 
-    # Ensure dependencies are installed in the machine
-    # from speckle.utils import enable_remote_debugging
-    # enable_remote_debugging()
-    startDebugger()
-    ensure_dependencies("QGIS")
+        from speckle_qgis import SpeckleQGIS
+        from specklepy.logging import metrics
 
-    from speckle_qgis import SpeckleQGIS
-    from specklepy.logging import metrics
+        version = (
+            Qgis.QGIS_VERSION.encode("iso-8859-1", errors="ignore")
+            .decode("utf-8")
+            .split(".")[0]
+        )
+        metrics.set_host_app("QGIS", f"QGIS{version}")
+        return SpeckleQGIS(iface)
 
-    version = (
-        Qgis.QGIS_VERSION.encode("iso-8859-1", errors="ignore")
-        .decode("utf-8")
-        .split(".")[0]
-    )
-    metrics.set_host_app("QGIS", f"QGIS{version}")
-    return SpeckleQGIS(iface)
+    class EmptyClass:
+        # https://docs.qgis.org/3.28/en/docs/pyqgis_developer_cookbook/plugins/plugins.html#mainplugin-py
+        def __init__(self, iface):
+            pass
 
+        def initGui(self):
+            pass
 
-class EmptyClass:
-    # https://docs.qgis.org/3.28/en/docs/pyqgis_developer_cookbook/plugins/plugins.html#mainplugin-py
-    def __init__(self, iface):
-        pass
+        def unload(self):
+            pass
 
-    def initGui(self):
-        pass
-
-    def unload(self):
-        pass
+except ModuleNotFoundError:
+    pass