Merge branch 'dev' into 2.x

Author: webbpinner

.eslintignore

@@ -1,3 +1,4 @@
 **/node_modules/
 **/test/
-**/venv/
+**/venv/
+**/config/*.js

.flake8

@@ -1,5 +1,6 @@
 [flake8]
 extend-ignore = E402
-exclude = .git,__pycache__,config,demo,docs,lib,node_modules,plugins,routes,sealog-files,test,venv
+exclude = .git,__pycache__,config,demo,docs,lib,node_modules,plugins,reporting*,routes,sealog-files,*spidertrack*,test,venv
+filename=*.py,*.py.dist
 max-line-length=100
 # max-complexity = 10

.github/workflows/docker-build-and-test.yml

@@ -0,0 +1,74 @@
+name: Docker Build and Run Test
+
+on:
+  push:
+    branches:
+      - 2.x  # Or any branch you want to trigger the workflow
+      - dev
+  pull_request:
+    branches:
+      - 2.x  # Or any branch you want to trigger the workflow
+      - dev
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    # services:
+      # You can define services that need to be running while testing
+      # For example, if your app relies on a database, you could define it here
+      # db:
+      #   image: postgres:latest
+      #   ports:
+      #     - 5432:5432
+
+    steps:
+    - name: Check out the repository
+      uses: actions/checkout@v3
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+
+    - name: Set up Docker Compose
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y docker-compose
+
+    - name: Create a sealog-files directory
+      run: |
+        sudo mkdir -p /data/sealog-files
+
+    - name: Generate a secret key
+      id: generate-secret
+      run: |
+        # Generate a random secret key using openssl
+        SECRET_KEY=$(openssl rand -base64 32)
+        echo "Generated secret key: $SECRET_KEY"
+        # Save the secret key for later steps
+        echo "SECRET_KEY=$SECRET_KEY" >> $GITHUB_ENV
+
+    - name: Modify docker-compose.yml
+      run: |
+        cp docker-compose.yml.dist docker-compose.yml
+
+        sed -i "s|<SECRET_TOKEN>|${{ secrets.SECRET_KEY }}|g" docker-compose.yml
+
+    - name: Modify Dockerfile
+      run: |
+        cp Dockerfile.dist Dockerfile
+
+    - name: Build and Run Docker Compose
+      run: |
+        docker-compose -f docker-compose.yml up -d --build
+        # Optionally, add a wait or check to ensure the container is running
+        docker-compose ps
+
+    # - name: Run tests or validation (if applicable)
+      # run: |
+        # You can run any tests or health checks here, e.g., using curl or a test script.
+        # Example for a web server test:
+        # curl -f http://localhost:8000/sealog-server || exit 1
+
+    - name: Tear down Docker Compose
+      run: |
+        docker-compose down

.gitignore

@@ -12,6 +12,7 @@ venv/
 
 # customize versions of the dist scripts
 misc/cache_udp_data*.py
+misc/coriolix_sealog/settings*.py
 misc/influx_sealog/settings*.py
 misc/python_sealog/settings*.py
 misc/reporting/sealog_doc_template*.py
@@ -25,6 +26,7 @@ misc/sealog_aux_data_inserter_nav.py
 misc/sealog_auxDataInserter*.py
 misc/sealog_backupDB.sh
 misc/sealog_build_*_report*.py
+misc/sealog_create_cruise_from_openvdm.py
 misc/sealog_cruise_responder.py
 misc/sealog_cruise_sync.py
 misc/sealog_lowering_responder.py

.husky/pre-commit

@@ -0,0 +1,9 @@
+
+echo "Linting NodeJS code with eslint..."
+eslint . --ext .js --ext .js.dist
+
+echo "Linting python code with Flake8..."
+./venv/bin/flake8 ./misc
+
+echo "Linting python code with PyLint..."
+./venv/bin/pylint ./misc

.pylintrc

@@ -52,7 +52,7 @@ ignore=CVS
 # ignore-list. The regex matches against paths and can be in Posix or Windows
 # format. Because '\\' represents the directory delimiter on Windows systems,
 # it can't be used as an escape character.
-ignore-paths=
+ignore-paths=.*(/reporting.*/|.*_spidertrack).*
 
 # Files or directories matching the regular expression patterns are skipped.
 # The regex matches against base names, not paths. The default value ignores
@@ -299,7 +299,7 @@ max-attributes=7
 max-bool-expr=5
 
 # Maximum number of branch for function / method body.
-max-branches=12
+max-branches=30
 
 # Maximum number of locals for function / method body.
 max-locals=15
@@ -426,21 +426,23 @@ confidence=HIGH,
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable=raw-checker-failed,
-        bad-inline-option,
-        locally-disabled,
+disable=bad-inline-option,
+        deprecated-pragma,
+        duplicate-code,
         file-ignored,
+        import-error,
+        line-too-long,
+        locally-disabled,
+        raw-checker-failed,
         suppressed-message,
-        useless-suppression,
-        deprecated-pragma,
-        use-symbolic-message-instead,
+        too-many-arguments,
+        too-many-positional-arguments,
         use-implicit-booleaness-not-comparison-to-string,
         use-implicit-booleaness-not-comparison-to-zero,
-        line-too-long,
-        import-error,
+        use-symbolic-message-instead,
+        useless-suppression,
         wrong-import-order,
-        wrong-import-position,
-        duplicate-code
+        wrong-import-position
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -470,7 +472,7 @@ notes-rgx=
 [REFACTORING]
 
 # Maximum number of nested blocks for function / method body
-max-nested-blocks=5
+max-nested-blocks=10
 
 # Complete name of functions that never returns. When checking for
 # inconsistent-return-statements if a never returning function is called then

INSTALL.md

@@ -82,9 +82,9 @@ Set the `senderAddress` and `notificationEmailAddresses` locations in the `./con
 
 You will also need to uncomment the type of email integration used.  By default email is disabled but the distribution file includes commented code blocks for gmail, mailgun and mailjet integration.
 
-Set the `host`, `port`, `wsPort`, and `prefix` values in the `./config/manifest.js` file to meet your specific installation requirements.  There are 3 sets of these variables for the various ways sealog-server can be run.  If you are only running one instance of Sealog Server on the server then the defaults are sufficient
+Set the `SERVER_PORT` value in the `./config/manifest.js` file to meet your specific installation requirements. If you are only running one instance of Sealog Server on the server then the default value is sufficient. If you plan to use SSL, add the complete privKey and fulchain filepaths to `<privKey.pem>` and `<fullchain.pem>`.
 
-Set the `imagePath`, `cruisePath` and `loweringPath` locations in the `./config/server_settings.js` file to meet your specific installation requirements.  These paths are where the framegrabber image files, cruise files and lowering files are located on the server.
+Set the `FILEPATH_ROOT` location in the `./config/server_settings.js` file to meet your specific installation requirements.
 
 Create a secret JWT encryption key and save it to the `./config/secret.js` file.  Create the key by running the following command:
 ```
@@ -196,20 +196,13 @@ If everything went correctly you should not be able to access the sealog-server
 By default sealog-server runs over http.  To run the server over https uncomment the following commented lines at the top of the `./config/manifest.js` file and replace `<privKey.pem>` and `<fullchain.pem>` with the appropriate cert files:
 
 ```
-// const Fs = require('fs')
-
-// const tlsOptions = {
-//   key: Fs.readFileSync(<privKey.pem>),
-//   cert: Fs.readFileSync(<fullchain.pem>)
-// };
-```
-
-AND the following line at line 103:
-```
-//    tls: tlsOptions,
+  tlsOptions = {
+    key: Fs.readFileSync(process.env.SEALOG_SERVER_TLS_PRIVKEY || '<privKey.pem>'),
+    cert: Fs.readFileSync(process.env.SEALOG_SERVER_TLS_FULLCHAIN || '<fullchain.pem>')
+  };
 ```
 
-**Note:** Make sure the user running the sealog-server process has read access to the certificate files.
+**Note:** Make sure the user running the sealog-server process has read access to the certificate files.  Make sure any clients communicating with the server know to use TLS.
 
 # Enabling Additional Functionality
 

config/manifest.js.dist

@@ -1,6 +1,8 @@
 const Fs = require('fs');
 const Pkg = require('../package.json');
 
+const SERVER_PORT = 8000;
+
 let tlsOptions = null;
 try {
   tlsOptions = {
@@ -71,7 +73,7 @@ const {
   sealogDB_devel
 } = require('../config/db_constants');
 
-const port = process.env.SEALOG_SERVER_PORT || 8000;
+const port = process.env.SEALOG_SERVER_PORT || SERVER_PORT;
 let env = process.env.NODE_ENV || 'development';
 env = (env === 'test') ? 'development' : env;
 env = ['demo-vehicle','demo-vessel'].includes(env) ? 'demo' : env;

config/server_settings.js.dist

@@ -14,7 +14,7 @@ const disableRegisteringUsers = false;
 const registeringUserRoles = ['event_watcher', 'event_logger'];
 
 // Activate per-cruise/per-lowering access permissions
-const useAccessControl = false;
+const useAccessControl = process.env.SEALOG_SERVER_USE_ACCESS_CONTROL || false;
 
 module.exports = {
   imagePath,

misc/cache_udp_data.py.dist

@@ -16,7 +16,7 @@ CREATED:    2018-09-26
 REVISION:   2021-04-27
 
 LICENSE INFO:   This code is licensed under MIT license (see LICENSE.txt for details)
-                Copyright (C) OceanDataTools.org 2024
+                Copyright (C) OceanDataTools.org 2025
 '''
 
 import socket
@@ -157,12 +157,12 @@ if __name__ == '__main__':
     import os
 
     parser = argparse.ArgumentParser(description='UDP Data Caching Service')
-    parser.add_argument('-v', '--verbosity', dest='verbosity',
-                        default=0, action='count',
-                        help='Increase output verbosity')
-    parser.add_argument('-i', '--ignore_stale', action='store_true',
-                        default=False,
-                        help='only save the new value if it\'s different than the previously recorded value')
+    parser.add_argument(
+        '-v', '--verbosity', dest='verbosity', default=0, action='count',
+        help='Increase output verbosity')
+    parser.add_argument(
+        '-i', '--ignore_stale', action='store_true', default=False,
+        help='only save the new value if it\'s different than the previously recorded value')
 
     parsed_args = parser.parse_args()
 
@@ -188,7 +188,7 @@ if __name__ == '__main__':
             try:
                 sys.exit(0)
             except SystemExit:
-                os._exit(0)  # pylint: disable=protected-access
+                os._exit(0)
 
         # Wait 5 seconds for the server to complete startup
         time.sleep(5)