Itdev 34721 email poc draft -ignore

.github/ISSUE_TEMPLATE/bug-fix.yml

@@ -0,0 +1,60 @@
+name: Bug Report
+description: Tell us about the bug/ error that you are seeing.
+title: "Bug: "
+labels: ["bug"]
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software are you running?
+      options:
+        - 1.1.5
+        - 1.1.4
+        - 1.1.3
+        - 1.1.2
+        - 1.1.1
+        - 1.1.0 or before
+  - type: dropdown
+    id: component
+    attributes:
+      label: Component
+      multiple: true
+      description: What component of the website was this issue in?
+      options:
+        - Projects
+        - Allocations
+        - Resources
+        - Administration
+        - Users
+        - Other
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Other
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: textarea
+    id: tasks
+    attributes:
+      label: Tasks/ user tests when bug is fixed
+      description: If relevant, add a list of tasks for anyone working on this issue and/ or tests for them to use when fixing the issue.
+      value: "- [ ] "

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,31 @@
+name: Feature Request
+description: Tell us about what new feature you want to see added to ColdFront!
+title: "Feature: "
+labels: ["documentation", "enhancement"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe your feature idea!
+    validations:
+      required: true
+  - type: dropdown
+    id: component
+    attributes:
+      label: Component
+      multiple: true
+      description: What component of the website does this issue enhance?
+      options:
+        - Projects
+        - Allocations
+        - Resources
+        - Administration
+        - Users
+        - Other
+  - type: textarea
+    id: info
+    attributes:
+      label: Additional information
+      description: If you have any example code/ ideas you would like to show, paste them here. This will be automatically formatted into code, so no need for backticks.
+      render: shell

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,29 @@
+## Description
+
+###### Please include a summary of the change and which issue is fixed, if applicable.
+
+Fixes #(issue number here)
+
+## Component
+
+###### What components of the website does this PR apply to? Select all that apply.
+- [ ] Projects
+- [ ] Allocations
+- [ ] Resources
+- [ ] Administration
+- [ ] Users
+- [ ] Other
+
+## Testing
+
+###### If relevant, add a list of tests below for anyone reviewing this PR to run to simplify the testing process.
+
+- [ ] Test #1:
+- [ ] Test #2:
+- [ ] Test #3:
+
+...
+
+## Documentation
+
+- [ ] Check this box if this PR will require us to update our [documentation](https://coldfront.readthedocs.io/en/latest/).

.github/workflows/actions.yml

@@ -0,0 +1,33 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main, staging ]
+  pull_request:
+    branches: [ main, staging ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    environment: test
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: install python packages
+        run: |
+          pip install -r requirements.txt
+
+      - name: run tests
+        run: python3 manage.py test --exclude-tag integration -b
+        env:
+          ENVIRONMENT: test
+          PLUGIN_QUMULO: True
+          AD_USER_PASS: ADPassword@123
+          AD_USERNAME: ADUsername
+          AD_SERVER_NAME: accounts-ldap.wusm.wustl.edu
+          AD_GROUPS_OU: OU=QA,OU=RIS,OU=Groups,DC=accounts,DC=ad,DC=wustl,DC=edu
+          STORAGE2_PATH: /foo/bar

.gitignore

@@ -7,7 +7,7 @@ build
 *.DS_Store
 *.swp
 env/
-venv/
+*venv/
 static_root/
 db.sqlite3
 local_data/
@@ -16,7 +16,6 @@ local_settings.py
 local_strings.py
 coldfront.db
 *.code-workspace
-.vscode
 db.json
 .env
 .devcontainer/*

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnSave": true
+    },
+    "[javascript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    }
+}

CHANGELOG.md

@@ -131,4 +131,5 @@
 [1.1.2]: https://github.com/ubccr/coldfront/releases/tag/v1.1.2
 [1.1.3]: https://github.com/ubccr/coldfront/releases/tag/v1.1.3
 [1.1.4]: https://github.com/ubccr/coldfront/releases/tag/v1.1.4
-[Unreleased]: https://github.com/ubccr/coldfront/compare/v1.1.4...HEAD
+[1.1.5]: https://github.com/ubccr/coldfront/releases/tag/v1.1.5
+[Unreleased]: https://github.com/ubccr/coldfront/compare/v1.1.6...HEAD

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.6
+FROM python:3.8
 
 RUN apt-get update \
     && apt-get install -y --no-install-recommends \

MANIFEST.in

@@ -11,3 +11,5 @@ recursive-include coldfront/core/publication/templates *
 recursive-include coldfront/core/grant/templates *
 recursive-include coldfront/core/user/templates *
 recursive-include coldfront/core/resource/templates *
+recursive-include coldfront/plugins/qumulo/templates *
+recursive-include coldfront/plugins/qumulo/static *

README.md

@@ -48,3 +48,59 @@ subscribe ccr-open-coldfront-list@listserv.buffalo.edu first_name last_name
 ## License
 
 ColdFront is released under the GPLv3 license. See the LICENSE file.
+
+## Testing
+
+### Setup
+To run tests, the following variables should be included in a `.env` file in the root directory of the repo:
+
+```
+PLUGIN_QUMULO=True
+AD_SERVER_NAME=foo
+AD_USERNAME=bar
+AD_USER_PASS=bah
+STORAGE2_PATH=/foo/bar
+```
+
+### Running
+A complete test suite can be run with `manage.py test`.  You can target sub-groups of tests by including a specifying argument.  Ex: `manage.py.test coldfront.plugins.qumulo.tests` will run only unit tests for the qumulo plugin.
+
+Typically, you'll want to run non integration tests separately, which can be done with `python manage.py test --exclude-tag integration`.  Integrations can be run with `python manage.py test --tag integration`.
+
+### Set up Local Environment and Run tests
+
+1. Go to the root of the `coldfront-wustl-fork` repo.
+2. Create a (Python) virtual environment: `python3 -mvenv coldfront-venv`
+3. Activate the virtual environment: `source coldfront-venv/bin/activate`
+4. Install the dependencies
+```
+pip install --upgrade pip
+pip install -r requirements-dev.txt
+```
+5. Run a test to verify the installation: `python manage.py test coldfront.plugins.qumulo.tests`
+
+**Steps for local development**
+```
+python3 -mvenv coldfront-venv
+source coldfront-venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements-dev.txt
+python manage.py test coldfront.plugins.qumulo.tests
+```
+
+### Integration Test ENV
+Integration Tests need to be run while connected to a VPN.  The following variables need to be included for functioning integration tests.  Credentials should be stored in the `pass` store.
+
+```
+PLUGIN_QUMULO=True
+QUMULO_HOST=
+QUMULO_PORT=
+QUMULO_USER=
+QUMULO_PASS=
+DEBUG=TRUE
+AD_USER_PASS=
+AD_USERNAME=
+AD_SERVER_NAME=
+AD_GROUPS_OU=OU=QA,OU=RIS,OU=Groups,DC=accounts,DC=ad,DC=wustl,DC=edu
+STORAGE2_PATH=
+```

coldfront/config/plugins/ldap_user_search.py

@@ -6,14 +6,19 @@
 except ImportError:
     raise ImproperlyConfigured('Please run: pip install ldap3')
 
-#------------------------------------------------------------------------------
-# This enables searching for users via LDAP
-#------------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
+#  This enables searching for users via LDAP
+# ----------------------------------------------------------------------------
 
 LDAP_USER_SEARCH_SERVER_URI = ENV.str('LDAP_USER_SEARCH_SERVER_URI')
 LDAP_USER_SEARCH_BASE = ENV.str('LDAP_USER_SEARCH_BASE')
-LDAP_USER_SEARCH_BIND_DN = ENV.str('LDAP_USER_SEARCH_BIND_DN')
-LDAP_USER_SEARCH_BIND_PASSWORD = ENV.str('LDAP_USER_SEARCH_BIND_PASSWORD')
+LDAP_USER_SEARCH_BIND_DN = ENV.str('LDAP_USER_SEARCH_BIND_DN', default=None)
+LDAP_USER_SEARCH_BIND_PASSWORD = ENV.str('LDAP_USER_SEARCH_BIND_PASSWORD', default=None)
 LDAP_USER_SEARCH_CONNECT_TIMEOUT = ENV.float('LDAP_USER_SEARCH_CONNECT_TIMEOUT', default=2.5)
 LDAP_USER_SEARCH_USE_SSL = ENV.bool('LDAP_USER_SEARCH_USE_SSL', default=True)
-ADDITIONAL_USER_SEARCH_CLASSES = ['coldfront.plugins.ldap_user_search.utils.LDAPUserSearch',]
+LDAP_USER_SEARCH_USE_TLS = ENV.bool('LDAP_USER_SEARCH_USE_TLS', default=False)
+LDAP_USER_SEARCH_PRIV_KEY_FILE = ENV.str("LDAP_USER_SEARCH_PRIV_KEY_FILE", default=None)
+LDAP_USER_SEARCH_CERT_FILE = ENV.str("LDAP_USER_SEARCH_CERT_FILE", default=None)
+LDAP_USER_SEARCH_CACERT_FILE = ENV.str("LDAP_USER_SEARCH_CACERT_FILE", default=None)
+
+ADDITIONAL_USER_SEARCH_CLASSES = ['coldfront.plugins.ldap_user_search.utils.LDAPUserSearch']

coldfront/config/plugins/openid.py

@@ -37,3 +37,4 @@
 OIDC_OP_USER_ENDPOINT = ENV.str('OIDC_OP_USER_ENDPOINT')
 OIDC_VERIFY_SSL = ENV.bool('OIDC_VERIFY_SSL', default=True)
 OIDC_RENEW_ID_TOKEN_EXPIRY_SECONDS = ENV.int('OIDC_RENEW_ID_TOKEN_EXPIRY_SECONDS', default=3600)
+OIDC_USE_PKCE = ENV.bool('OIDC_USE_PKCE', default=False)

coldfront/config/plugins/qumulo.py

@@ -0,0 +1,16 @@
+from coldfront.config.base import (
+    INSTALLED_APPS,
+    TEMPLATES,
+    PROJECT_ROOT,
+    STATICFILES_DIRS,
+)
+
+INSTALLED_APPS += [
+    "coldfront.plugins.qumulo",
+]
+
+STATICFILES_DIRS += [
+    PROJECT_ROOT("coldfront/plugins/qumulo/static"),
+]
+
+TEMPLATES[0]["DIRS"] += [PROJECT_ROOT("coldfront/plugins/qumulo/templates")]

coldfront/config/settings.py

@@ -22,6 +22,7 @@
     'PLUGIN_AUTH_OIDC': 'plugins/openid.py',
     'PLUGIN_AUTH_LDAP': 'plugins/ldap.py',
     'PLUGIN_LDAP_USER_SEARCH': 'plugins/ldap_user_search.py',
+    'PLUGIN_QUMULO': 'plugins/qumulo.py',
 }
 
 # This allows plugins to be enabled via environment variables. Can alternatively

coldfront/config/urls.py

@@ -11,6 +11,7 @@
 admin.site.site_header = 'ColdFront Administration'
 admin.site.site_title = 'ColdFront Administration'
 
+
 urlpatterns = [
     path('admin/', admin.site.urls),
     path('robots.txt', TemplateView.as_view(template_name='robots.txt', content_type='text/plain'), name="robots"),
@@ -36,3 +37,6 @@
 
 if 'django_su.backends.SuBackend' in settings.AUTHENTICATION_BACKENDS:
     urlpatterns.append(path('su/', include('django_su.urls')))
+
+if 'coldfront.plugins.qumulo' in settings.INSTALLED_APPS:
+    urlpatterns.append(path('qumulo/', include('coldfront.plugins.qumulo.urls'), name='qumulo'))