@syngrisi/syngrisi 2.2.1

package/.nvmrc

@@ -0,0 +1 @@
+v20.9.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2023 Viktar Silakou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,139 @@
+# Syngrisi: Visual Testing Tool <a name="about"></a>
+
+Syngrisi is designed to facilitate automated visual regression testing. It seamlessly integrates with both new and
+existing test automation kits, providing an API for automated solutions and a user-friendly UI for reviewing and
+managing visual test data.
+
+## Try with a Single-Click
+
+To quickly preview the project without setting it up locally, click the 'Open in Gitpod' button. Gitpod will automatically set up an environment, install the [Syngrisi Cucumber Boilerplate Project](https://github.com/syngrisi/syngrisi-cucumber-boilerplate), and launch the Syngrisi instance for you.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/syngrisi/syngrisi-cucumber-boilerplate)
+
+## System Prerequisites <a name="prerequisites"></a>
+
+There are two modes in which Syngrisi can be run:
+
+- **Native Mode:** Utilize Node.js to run Syngrisi directly on your operating system for local execution.
+- **Container Mode:** Utilizing Docker and Docker Compose, this mode is more apt for production environments.
+
+### Native Mode
+
+* [NodeJS](https://nodejs.org/en/download/) `v20.9.0` or above.
+* [MongoDB Community Edition](https://docs.mongodb.com/manual/administration/install-community/) `6.0` or above
+
+### Container Mode
+
+* [Docker + Docker Compose](https://docs.docker.com/engine/install/)
+
+## Quick Start
+
+https://user-images.githubusercontent.com/23633060/225095007-39ee0a29-61c1-4f46-99ab-1af67052accb.mp4
+
+> 💡If you want to try Syngrisi for the first time, you can use [boilerplate projects](#boilerplates); they are installed easily and quickly and allow you to evaluate the basic capabilities of the tool.
+
+### Native Mode Installation
+
+To install Syngrisi in the current folder:
+
+```bash
+npm init sy@latest
+```
+
+To install to a specific folder:
+
+```bash
+npm init sy@latest <path_to_syngrisi>
+```
+
+For more details on setup customization, refer to the [create-sy](../create-sy) package documentation.
+
+> ⚠️ Important: Ensure that MongoDB is running before starting Syngrisi in native mode.
+
+To run the server, execute:
+
+```shell script
+npx sy
+```
+
+### Container Mode
+
+In addition to running the application natively, it can also be launched in a Docker container using a Docker Compose
+file. To download and execute Docker and Docker Compose files for Syngrisi, follow these steps:
+
+```bash
+# Check if docker-compose is installed
+command -v docker-compose >/dev/null 2>&1 || { echo >&2 "docker-compose is required; please install it and run this command again."; exit 1; }
+
+# Create the project folder
+mkdir my_new_syngrisi_project && cd my_new_syngrisi_project
+
+# Download Docker and Docker Compose files
+curl -LO https://raw.githubusercontent.com/syngrisi/syngrisi/main/packages/syngrisi/syngrisi-app.dockerfile
+curl -LO https://raw.githubusercontent.com/syngrisi/syngrisi/main/packages/syngrisi/docker-compose.yml
+
+# Create and start services
+sudo docker-compose up
+```
+
+You are free to modify the Docker Compose file according to your requirements. Ensure that service definitions and options are set up correctly; otherwise, services may not function as expected.
+
+Environment variables for Docker Compose can be configured either in an environment file or directly in the shell. For detailed
+configuration instructions, please refer to the Syngrisi documentation.
+
+```shell script
+sudo docker-compose up
+```
+
+## Syngrisi Boilerplates  <a name="boilerplates"></a>
+
+To quickly take a look at Syngrisi or start a new automation test project, you can use one of the boilerplates:
+
+* [Syngrisi Cucumber Boilerplate project](https://github.com/syngrisi/syngrisi-cucumber-boilerplate): the project contains all the necessary steps for functional tests + steps for visual checks.
+* [Syngrisi Playwright Boilerplate](https://github.com/syngrisi/syngrisi-playwright-boilerplate): Starter project for functional Playwright tests with the ability to do visual checks based on Syngrisi
+
+## Configuration via Environment Variables <a name="env"></a>
+
+Customize Syngrisi's behavior effortlessly using environment variables, without any need to modify the codebase.
+The System Environment variables have priority more than correspondent Syngrisi Admin Settings if they exist.
+For example, to set the log level to debug, use the following command:
+
+Windows:`set SYNGRISI_LOG_LEVEL=debug`
+macOS/Linux: `export SYNGRISI_LOG_LEVEL=debug`
+
+You can also include the variables in your `.env` or modify variables in `docker-compose.yml` file before start Syngrisi
+service.
+
+| Variable                       | Host | Docker | Description                                                                                                                                                       | Default Value                          |
+|--------------------------------|------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|
+| `SYNGRISI_DOCKER_IMAGES_PATH`  | -    | +      | Path to the internal Docker folder for Syngrisi images, including screenshots and diffs.                                                                          | `./.snapshots-images`                  |
+| `SYNGRISI_DOCKER_PORT`         | -    | +      | Docker external Syngrisi App Server Port (host port)                                                                                                              | `5000`                                 |
+| `SYNGRISI_DOCKER_DB_PORT`      | -    | +      | Docker external Syngrisi Database Server Port (host port)                                                                                                         | `27017`                                |
+| `SYNGRISI_DOCKER_DB_AUTH_ARG`  | -    | +      | To enable mongo database authentication set it to `--auth` be sure that you create user for `SyngrisiDb` database and add appropriate values to connection string | `--noauth`                             |
+| `SYNGRISI_DOCKER_BACKUPS_PATH` | -    | +      | Host Backup Folder path                                                                                                                                           | ./backups/                             |
+| `SYNGRISI_DOCKER_DB_PATH`      | -    | +      | Host Path to Syngrisi Database files                                                                                                                              | `./data/db_data`                       |
+| `SYNGRISI_DB_URI`              | +    | +      | [Connection URI](https://www.mongodb.com/docs/manual/reference/connection-string/) for Mongo DB service                                                           | `mongodb://127.0.0.1:27017/SyngrisiDb` |
+| `SYNGRISI_IMAGES_PATH`         | +    | +      | Path to the folder for Syngrisi images, including screenshots and diffs.                                                                                          | `./.snapshots-images/`                 |
+| `SYNGRISI_APP_PORT`            | +    | -      | TCP port for application server                                                                                                                                   | `3000`                                 |
+| `SYNGRISI_AUTH`                | +    | +      | Enables authentication                                                                                                                                            | `1`                                    |
+| `MONGODB_ROOT_USERNAME`        | -    | +      | Username for the Database Root user, that will be created at first Applications start                                                                             | -                                      |
+| `MONGODB_ROOT_PASSWORD`        | -    | +      | Password for the Database Root user, that will be created at first Applications start                                                                             | -                                      |
+| `LOGLEVEL`                     | +    | -      | Log level (`error` `warn`,`info`,`verbose`,`debug`,`silly`)                                                                                                       | `debug`                                |
+| `SYNGRISI_PAGINATION_SIZE`     | +    | -      | Number of tests items on that return `/checks?page={page_num}` API                                                                                                | `50`                                   |
+| `SYNGRISI_TEST_MODE`           | +    | +      | Enables test admin user if equal `1`, used only for tests purposes                                                                                                | `0`                                    |
+| `SYNGRISI_DISABLE_FIRST_RUN`   | +    | +      | Disable first run procedure, disabled if equal `1`, used only for tests purposes                                                                                  | `0`                                    |
+| `SYNGRISI_DISABLE_DEV_CORS`    | +    | -      | Disable CORS for vite dev server, only for dev and test purposes                                                                                                  | `-`                                    |
+| `SYNGRISI_SESSION_STORE_KEY`   | +    | +      | A Secret for session storage                                                                                                                                      | random generated                       |
+| `SYNGRISI_COVERAGE`            | +    | -      | Enable coverage, if `true` generated coverage data to `./coverage`                                                                                                | -                                      |
+| `SYNGRISI_HTTP_LOG`            | +    | +      | Enable HTTP logs, if `true` logging all HTTP request to `./logs/http.log` file                                                                                    | `false`                                |
+
+## Devices list <a name="devices"></a>
+
+Syngrisi includes a [list](./static/data/custom_devices.json) of recognized devices, sourced from BrowserStack.
+
+The application sets the platform icon based on this list. Do not edit this file directly. If you wish to add your own devices, simply create an additional file named `custom_devices.json`; the data from this file will be appended to the main list.
+
+## License
+
+Syngrisi is available under the MIT License. For more details, refer to the [LICENSE](./LICENSE.md) file.
+

package/config.js

@@ -0,0 +1,17 @@
+const fs = require('fs');
+require('dotenv')
+    .config();
+
+const bsPath = process.env.SYNGRISI_IMAGES_PATH || './.snapshots-images/';
+if (!fs.existsSync(bsPath)) {
+    fs.mkdirSync(bsPath, { recursive: true });
+}
+
+exports.config = {
+    defaultImagesPath: bsPath,
+    connectionString: process.env.SYNGRISI_DB_URI || process.env.VRS_CONN_STRING || 'mongodb://127.0.0.1:27017/SyngrisiDb',
+    port: process.env.SYNGRISI_APP_PORT || 3000,
+    backupsFolder: './backups',
+    enableHttpLogger: process.env.SYNGRISI_HTTP_LOG,
+    httpLoggerFilePath:  './logs/http.log'
+};

package/dist/config.js

@@ -0,0 +1,16 @@
+"use strict";
+const fs = require('fs');
+require('dotenv')
+    .config();
+const bsPath = process.env.SYNGRISI_IMAGES_PATH || './.snapshots-images/';
+if (!fs.existsSync(bsPath)) {
+    fs.mkdirSync(bsPath, { recursive: true });
+}
+exports.config = {
+    defaultImagesPath: bsPath,
+    connectionString: process.env.SYNGRISI_DB_URI || process.env.VRS_CONN_STRING || 'mongodb://127.0.0.1:27017/SyngrisiDb',
+    port: process.env.SYNGRISI_APP_PORT || 3000,
+    backupsFolder: './backups',
+    enableHttpLogger: process.env.SYNGRISI_HTTP_LOG,
+    httpLoggerFilePath: './logs/http.log'
+};

package/dist/src/server/models/index.js

@@ -0,0 +1,508 @@
+"use strict";
+/* eslint-disable valid-jsdoc,func-names */
+const passportLocalMongoose = require('passport-local-mongoose');
+const mongoose = require('mongoose');
+const { toJSON, paginate, paginateDistinct } = require('./plugins');
+const { Schema } = mongoose;
+const SnapshotSchema = new Schema({
+    name: {
+        type: String,
+        required: 'SnapshotSchema: the name of the snapshot entity is empty',
+    },
+    path: {
+        type: String,
+    },
+    filename: {
+        type: String,
+    },
+    imghash: {
+        type: String,
+        required: 'SnapshotSchema: the image hash of the snapshot entity is empty',
+    },
+    createdDate: {
+        type: Date,
+        default: Date.now,
+    },
+    vOffset: {
+        type: Number,
+    },
+    hOffset: {
+        type: Number,
+    },
+});
+const CheckSchema = new Schema({
+    name: {
+        type: String,
+        required: 'CheckSchema: the name of the check entity is empty',
+    },
+    test: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSTest',
+        required: 'CheckSchema: the test name of the check entity is empty',
+    },
+    suite: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSSuite',
+        required: 'CheckSchema: the app field is empty',
+    },
+    app: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSApp',
+        required: 'CheckSchema: the app field is empty',
+    },
+    branch: {
+        type: String,
+    },
+    realBaselineId: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSBaseline',
+    },
+    baselineId: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSSnapshot',
+    },
+    actualSnapshotId: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSSnapshot',
+    },
+    diffId: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSSnapshot',
+    },
+    createdDate: {
+        type: Date,
+        required: true,
+        default: Date.now,
+    },
+    updatedDate: {
+        type: Date,
+    },
+    status: {
+        type: [{
+                type: String,
+                enum: {
+                    values: ['new', 'pending', 'approved', 'running', 'passed', 'failed', 'aborted'],
+                    message: 'status is required',
+                },
+            }],
+        default: 'new',
+    },
+    browserName: {
+        type: String,
+    },
+    browserVersion: {
+        type: String,
+    },
+    browserFullVersion: {
+        type: String,
+    },
+    viewport: {
+        type: String,
+    },
+    os: {
+        type: String,
+    },
+    domDump: {
+        type: String,
+    },
+    result: {
+        type: String,
+        default: '{}',
+    },
+    run: {
+        type: Schema.Types.ObjectId,
+    },
+    markedAs: {
+        type: String,
+        enum: ['bug', 'accepted'],
+    },
+    markedDate: {
+        type: Date,
+    },
+    markedById: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSUser',
+    },
+    markedByUsername: {
+        type: String,
+    },
+    markedBugComment: {
+        type: String,
+    },
+    creatorId: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSUser',
+    },
+    creatorUsername: {
+        type: String,
+    },
+    failReasons: {
+        type: [String],
+    },
+    vOffset: {
+        type: String,
+    },
+    topStablePixels: {
+        type: String,
+    },
+    meta: {
+        type: Object,
+    },
+});
+const BaselineSchema = new Schema({
+    snapshootId: Schema.Types.ObjectId,
+    name: {
+        type: String,
+        required: 'VRSBaselineSchema: the name of the snapshoot entity is empty',
+    },
+    app: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSApp',
+        required: 'VRSBaselineSchema: the app field is empty',
+    },
+    branch: {
+        type: String,
+    },
+    browserName: {
+        type: String,
+    },
+    browserVersion: {
+        type: String,
+    },
+    browserFullVersion: {
+        type: String,
+    },
+    viewport: {
+        type: String,
+    },
+    os: {
+        type: String,
+    },
+    markedAs: {
+        type: String,
+        enum: ['bug', 'accepted'],
+    },
+    lastMarkedDate: {
+        type: Date,
+    },
+    createdDate: {
+        type: Date,
+    },
+    updatedDate: {
+        type: Date,
+    },
+    markedById: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSUser',
+    },
+    markedByUsername: {
+        type: String,
+    },
+    ignoreRegions: {
+        type: String,
+    },
+    boundRegions: {
+        type: String,
+    },
+    matchType: {
+        type: String,
+        // enum: ['antialiasing', 'nothing', 'less', 'colors', 'alpha'],
+        enum: ['antialiasing', 'nothing', 'colors'],
+    },
+    meta: {
+        type: Object,
+    },
+});
+const TestSchema = new Schema({
+    name: {
+        type: String,
+        required: 'TestSchema: the test name is empty',
+    },
+    description: {
+        type: String,
+    },
+    status: {
+        type: String,
+    },
+    browserName: {
+        type: String,
+    },
+    browserVersion: {
+        type: String,
+    },
+    branch: {
+        type: String,
+    },
+    tags: {
+        type: [String],
+    },
+    viewport: {
+        type: String,
+    },
+    // after handle all checks inside the test
+    calculatedViewport: {
+        type: String,
+    },
+    os: {
+        type: String,
+    },
+    app: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSApp',
+        required: 'TestSchema: the app field is empty',
+    },
+    blinking: {
+        type: Number,
+        default: 0,
+    },
+    updatedDate: {
+        type: Date,
+    },
+    startDate: {
+        type: Date,
+    },
+    checks: [
+        {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'VRSCheck',
+        },
+    ],
+    suite: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSSuite',
+    },
+    run: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSRun',
+    },
+    markedAs: {
+        type: String,
+        enum: ['Bug', 'Accepted', 'Unaccepted', 'Partially'],
+    },
+    creatorId: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSUser',
+    },
+    creatorUsername: {
+        type: String,
+    },
+    meta: {
+        type: Object,
+    },
+}, { strictQuery: true }); // remove filters that not exist in schema
+const SuiteSchema = new Schema({
+    name: {
+        type: String,
+        default: 'Others',
+        unique: true,
+        required: 'SuiteSchema: the suite name is empty',
+    },
+    tags: {
+        type: [String],
+    },
+    app: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSApp',
+        required: 'SuiteSchema: the app field is empty',
+    },
+    description: {
+        type: String,
+    },
+    updatedDate: {
+        type: Date,
+        default: Date.now,
+    },
+    createdDate: {
+        type: Date,
+    },
+    meta: {
+        type: Object,
+    },
+});
+const RunSchema = new Schema({
+    name: {
+        type: String,
+        required: 'RunSchema: the run name cannot be empty',
+    },
+    app: {
+        type: Schema.Types.ObjectId,
+        ref: 'VRSApp',
+        required: 'RunSchema: the app field is empty',
+    },
+    ident: {
+        type: String,
+        unique: true,
+        required: 'RunSchema: the run ident run cannot be empty',
+    },
+    description: {
+        type: String,
+    },
+    updatedDate: {
+        type: Date,
+        default: Date.now,
+    },
+    createdDate: {
+        type: Date,
+    },
+    parameters: {
+        type: [String],
+    },
+    meta: {
+        type: Object,
+    },
+});
+const LogSchema = new Schema({
+    timestamp: {
+        type: Date,
+    },
+    level: {
+        type: String,
+    },
+    message: {
+        type: String,
+    },
+    meta: {
+        type: Object,
+    },
+    hostname: {
+        type: Object,
+    },
+});
+// this is the Projects Schema `VRSAppSchema` name is for historical reason
+const AppSchema = new Schema({
+    name: {
+        type: String,
+        default: 'Others',
+        unique: true,
+        required: 'AppSchema: the Application name is empty',
+    },
+    description: {
+        type: String,
+    },
+    version: {
+        type: String,
+    },
+    updatedDate: {
+        type: Date,
+    },
+    createdDate: {
+        type: Date,
+    },
+    meta: {
+        type: Object,
+    },
+});
+const UserSchema = new Schema({
+    username: {
+        type: String,
+        unique: true,
+        required: 'UserSchema: the username name is empty',
+    },
+    firstName: {
+        type: String,
+        required: 'UserSchema: the firstName name is empty',
+    },
+    lastName: {
+        type: String,
+        required: 'UserSchema: the lastName name is empty',
+    },
+    role: {
+        type: String,
+        enum: {
+            values: ['admin', 'reviewer', 'user'],
+            message: 'UserSchema: role is required',
+            required: 'UserSchema: role is required',
+        },
+    },
+    password: {
+        type: String,
+    },
+    token: {
+        type: String,
+    },
+    apiKey: {
+        type: String,
+    },
+    createdDate: {
+        type: Date,
+    },
+    updatedDate: {
+        type: Date,
+    },
+    expiration: {
+        type: Date,
+    },
+    meta: {
+        type: Object,
+    },
+});
+const AppSettingsSchema = new Schema({
+    name: {
+        type: String,
+        unique: true,
+        required: 'AppSettingsSchema: the name is empty',
+    },
+    label: {
+        type: String,
+        required: 'AppSettingsSchema: the label is empty',
+    },
+    description: {
+        type: String,
+    },
+    type: {
+        type: String,
+        required: 'AppSettingsSchema: the type is empty',
+    },
+    value: {
+        type: Schema.Types.Mixed,
+        required: 'AppSettingsSchema: the value is empty',
+    },
+    env_variable: {
+        type: String,
+    },
+    enabled: {
+        type: Boolean,
+    },
+});
+AppSettingsSchema.plugin(toJSON);
+LogSchema.plugin(toJSON);
+LogSchema.plugin(paginate);
+UserSchema.plugin(toJSON);
+UserSchema.plugin(paginate);
+RunSchema.plugin(paginate);
+RunSchema.plugin(toJSON);
+SuiteSchema.plugin(paginate);
+SuiteSchema.plugin(toJSON);
+AppSchema.plugin(paginate);
+AppSchema.plugin(toJSON);
+BaselineSchema.plugin(toJSON);
+BaselineSchema.plugin(paginate);
+SnapshotSchema.plugin(toJSON);
+SnapshotSchema.plugin(paginate);
+CheckSchema.plugin(toJSON);
+CheckSchema.plugin(paginate);
+TestSchema.plugin(toJSON);
+TestSchema.plugin(paginate);
+TestSchema.plugin(paginateDistinct);
+/**
+ * Check if email is taken
+ * @param {string} username - The user's email
+ * @param {ObjectId} [excludeUserId] - The id of the user to be excluded
+ * @returns {Promise<boolean>}
+ */
+UserSchema.statics.isEmailTaken = async function (username, excludeUserId) {
+    const user = await this.findOne({ username, _id: { $ne: excludeUserId } });
+    return !!user;
+};
+UserSchema.plugin(passportLocalMongoose, { hashField: 'password' });
+const Snapshot = mongoose.model('VRSSnapshot', SnapshotSchema);
+const Check = mongoose.model('VRSCheck', CheckSchema);
+const Test = mongoose.model('VRSTest', TestSchema);
+const Log = mongoose.model('VRSLog', LogSchema);
+const Suite = mongoose.model('VRSSuite', SuiteSchema);
+const App = mongoose.model('VRSApp', AppSchema);
+const Run = mongoose.model('VRSRun', RunSchema);
+const User = mongoose.model('VRSUser', UserSchema);
+const Baseline = mongoose.model('VRSBaseline', BaselineSchema);
+const AppSettings = mongoose.model('VRSAppSettings', AppSettingsSchema);
+module.exports = { Snapshot, Check, Test, Log, Suite, App, Run, User, Baseline, AppSettings };

package/dist/src/server/models/plugins/index.js

@@ -0,0 +1,4 @@
+"use strict";
+module.exports.toJSON = require('./toJSON.plugin');
+module.exports.paginate = require('./paginate.plugin');
+module.exports.paginateDistinct = require('./paginateDistinct.plugin');