IVS-216 document severities

.github/workflows/build-and-deploy-docs.yml

@@ -0,0 +1,31 @@
+name: "Build docs with Sphinx and deploy to Github Pages"
+
+on: 
+  push:
+    branches: docs/gh-pages
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      pages: write
+    env:
+      INPUT_DOCS-FOLDER: docs
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build HTML
+      uses: civilx64/sphinx-action@master
+      with:
+        docs-folder: docs/
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        # Upload html docs
+        path: './docs/_build/html'
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/build-docs.yml

@@ -0,0 +1,28 @@
+name: "Build docs with Sphinx"
+
+on: 
+  pull_request:
+    branches: docs/gh-pages
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      pages: write
+    env:
+      INPUT_DOCS-FOLDER: docs
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build HTML
+      uses: civilx64/sphinx-action@master
+      with:
+        docs-folder: docs/
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        # Upload html docs
+        path: './docs/_build/html'

.github/workflows/ci_cd.yml

@@ -79,7 +79,16 @@ jobs:
           source venv/bin/activate
           pip install --upgrade pip
           pip install -r requirements.txt
-          pip install ifcopenshell # TEMP workaround
+
+      - name: Install ifcopenshell package (temp)
+        run: |
+          cd backend
+          source venv/bin/activate
+          # use version of ifcopenshell with desired schema parsing
+          # TODO: revert to pyPI when schema parsing is published in the future
+          wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.8.1-92b63a0-linux64.zip"
+          mkdir -p venv/lib/python3.11/site-packages
+          unzip -d venv/lib/python3.11/site-packages /tmp/ifcopenshell_python.zip
 
       - name: Check Django config
         run: |

Makefile

@@ -71,4 +71,6 @@ clean-all:
 
 fetch-modules:
 	git submodule update --init --recursive
-	git submodule update --remote
+	git submodule foreach git clean -f .
+	git submodule foreach git reset --hard
+	git submodule update --remote --recursive

backend/Makefile

@@ -13,7 +13,7 @@ install: venv
 	. $(VIRTUAL_ENV)/bin/activate && \
 	pip install --upgrade pip && \
 	pip install -r requirements.txt && \
-    wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.7.9-c18e4ea-linux64.zip" && \
+    wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.8.1-92b63a0-linux64.zip" && \
     mkdir -p $(VIRTUAL_ENV)/lib/python3.11/site-packages && \
     unzip -f -d $(VIRTUAL_ENV)/lib/python3.11/site-packages /tmp/ifcopenshell_python.zip && \
 	rm /tmp/ifcopenshell_python.zip
@@ -22,7 +22,7 @@ install-macos: venv
 	. $(VIRTUAL_ENV)/bin/activate && \
 	pip install --upgrade pip && \
 	pip install -r requirements.txt && \
-	wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.7.9-c18e4ea-macos64.zip" && \
+	wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.8.1-92b63a0-macos64.zip" && \
 	mkdir -p $(VIRTUAL_ENV)/lib/python3.11/site-packages && \
 	unzip /tmp/ifcopenshell_python.zip -d .dev/venv/lib/python3.11/site-packages && \
 	rm /tmp/ifcopenshell_python.zip

backend/apps/ifc_validation/tasks.py

@@ -330,6 +330,17 @@ def parse_info_subtask(self, prev_result, id, file_name, *args, **kwargs):
 
         task.mark_as_initiated()
 
+        # try to open IFC file (catch segfaults)
+        try:
+            code = "import ifcopenshell; ifcopenshell.open('" + file_path + "')"
+            check_program = [sys.executable, '-c', code, file_path]
+            logger.debug(f'Command for {self.__qualname__}: {" ".join(check_program)}')
+            subprocess.run(check_program, check=True)
+
+        except subprocess.CalledProcessError as err:
+            task.mark_as_failed(err)
+            raise
+
         # retrieve IFC info
         try:
             task.set_process_details(None, f"(module) ifcopenshell.open() for file '{file_path}')")

docker/backend/Dockerfile

@@ -37,7 +37,7 @@ RUN --mount=type=cache,target=/root/.cache \
     pip install --no-cache-dir -r /app/backend/requirements.txt && \    
     # use version of ifcopenshell with desired schema parsing
     # TODO: revert to pyPI when schema parsing is published in the future
-    wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.7.9-c18e4ea-linux64.zip" && \
+    wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.8.1-92b63a0-linux64.zip" && \
     mkdir -p /opt/venv/lib/python3.11/site-packages  && \
     unzip -d /opt/venv/lib/python3.11/site-packages /tmp/ifcopenshell_python.zip && \
     # some cleanup

docs/.gitignore

@@ -0,0 +1 @@
+_build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,33 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'buildingSMART Validation Service'
+copyright = '2024, buildingSMART International'
+author = 'buildingSMART International'
+release = '0.6'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx_rtd_theme',
+    'myst_parser',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_favicon = '_static/favicon.ico'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+myst_links_external_new_tab = True