Validate features

.github/PULL_REQUEST_TEMPLATE.md

@@ -18,10 +18,10 @@ Closes #0000, References #0000, etc.
 - ...
 
 #### Checklist for Reviewers
-<!-- Guidelines to follow when reviewing pull request -->
+<!-- Guidelines to follow when reviewing pull request, please do not remove. -->
 
 - [ ] Title and description should be descriptive (Not just a serial number for example).
-- [ ] `vendorProfileID` should not be `vendorID`.
+- [ ] `vendorProfileID` should not be `vendorID` and should be a unique value for every profile.
 - [ ] All devices should be listed in the vendor's `index.yaml` file.
 - [ ] At least 1 image per device and should be transparent.
 

Makefile

@@ -19,6 +19,8 @@ GO = go
 GOBIN = $(PWD)/bin
 export GOBIN
 
+vendor-id=
+
 .PHONY: default
 default: validate
 
@@ -34,7 +36,11 @@ deps.update:
 
 .PHONY: validate
 validate:
-	$(NPM) run validate
+	@if [ -z "${vendor-id}" ]; then \
+        $(NPM) run validate; \
+    else \
+        $(NPM) run validate -- --vendor-id $(vendor-id); \
+    fi
 
 .PHONY: fmt
 fmt:

README.md

@@ -71,6 +71,12 @@ To validate data:
 $ make validate
 ```
 
+The validation also supports validating a single vendor's files:
+
+```bash
+$ make validate vendor-id=<id-of-vendor>
+```
+
 [Visual Studio Code](https://code.visualstudio.com/) is a great editor for editing the Device Repository. You can validate your data automatically using the [YAML plugin](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml).
 
 The YAML plugin supports you with filling out the document. When hitting Ctrl + Space, all fields are shown. The Debug Console of Visual Studio provides feedback by highlighting the incorrect fields.
@@ -218,10 +224,10 @@ There are a few guidelines to follow for images:
 Each referenced end device profile needs to be defined in the **End device profile**, with the same filename as the profile ID: `vendor/<vendor-id>/<profile-id>.yaml`:
 
 ```yaml
-# Vendor profile ID, can be freely issued by the vendor. NOTE: The vendor profile ID is different from the vendorID. 
-# The vendor Profile ID should be an incremental counter for every unique device listed in the vendor's folder.
-# This vendor profile ID is also used on the QR code for LoRaWAN devices, see
-# https://lora-alliance.org/wp-content/uploads/2020/11/TR005_LoRaWAN_Device_Identification_QR_Codes.pdf
+# The vendorProfileID is a distinct (preferably incremental) value for every unique profile listed in the vendor's folder.
+# This value can be freely issued by the vendor and is also used on the QR code for LoRaWAN devices, see
+# https://lora-alliance.org/wp-content/uploads/2020/11/TR005_LoRaWAN_Device_Identification_QR_Codes.pdf#page=8
+# NOTE: The vendorProfileID is different from the vendorID. 
 vendorProfileID: 0
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1

bin/pre-commit

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+make validate fmt
+make validate
+
+validation_output=$(node ./validate.js 2>&1)
+
+# Capture the exit status of the validation script
+VALIDATION_STATUS=$?
+
+# Check the exit status
+if [ $VALIDATION_STATUS -ne 0 ]; then
+
+    # Display the last line of the validation log
+    last_line=$(echo "$validation_output" | tail -n 1)
+    echo "$last_line"
+
+    exit 1
+fi

bin/validate.js

@@ -12,13 +12,19 @@ const imageType = require('image-type');
 
 const ajv = new Ajv({ schemas: [require('../lib/payload.json'), require('../schema.json')] });
 
-const options = yargs.usage('Usage: --vendor <file>').option('v', {
-  alias: 'vendor',
-  describe: 'Path to vendor index file',
-  type: 'string',
-  demandOption: true,
-  default: './vendor/index.yaml',
-}).argv;
+const options = yargs
+  .usage('Usage: --vendor <file> [--vendor-id <id>]')
+  .option('v', {
+    alias: 'vendor',
+    describe: 'Path to vendor index file',
+    type: 'string',
+    demandOption: true,
+    default: './vendor/index.yaml',
+  })
+  .option('vendor-id', {
+    describe: 'Specific vendor ID to validate',
+    type: 'string',
+  }).argv;
 
 let validateVendorsIndex = ajv.compile({
   $ref: 'https://schema.thethings.network/devicerepository/1/schema#/definitions/vendorsIndex',
@@ -202,6 +208,44 @@ function formatValidationErrors(errors) {
   return errors.map((e) => `${e.dataPath} ${e.message}`);
 }
 
+const vendorsIndex = yaml.load(fs.readFileSync(options.vendor));
+
+// Validate vendors index
+if (!validateVendorsIndex(vendorsIndex)) {
+  console.error(`${options.vendor} index is invalid: ${formatValidationErrors(validateVendorsIndex.errors)}`);
+  process.exit(1);
+}
+console.log(`vendor index: valid`);
+
+// Get the list of vendor IDs from the vendor/index.yaml
+const vendorIdsInIndex = vendorsIndex.vendors.map((vendor) => vendor.id);
+
+// Get the list of vendor folders in the vendor directory
+const vendorFolders = fs
+  .readdirSync('./vendor', { withFileTypes: true })
+  .filter((dirent) => dirent.isDirectory())
+  .map((dirent) => dirent.name);
+
+// Check for vendors in the vendor folder that are not in the vendor/index.yaml
+const vendorsNotInIndex = vendorFolders.filter((vendorId) => {
+  // Check if any vendor ID in the index is present in the folder name, or vice versa
+  const normalizedVendorId = vendorId.toLowerCase(); // Normalize for case-insensitive comparison
+  return (
+    !vendorIdsInIndex.some((indexId) => normalizedVendorId.includes(indexId.toLowerCase())) &&
+    !vendorIdsInIndex.some((indexId) => indexId.toLowerCase().includes(normalizedVendorId))
+  );
+});
+
+if (vendorsNotInIndex.length > 0) {
+  console.error(
+    `Vendors found in the 'vendor' folder that are not listed in ${options.vendor} index:\n${vendorsNotInIndex.join(
+      ', '
+    )}`
+  );
+  process.exit(1);
+}
+console.log(`All vendors in the 'vendor' folder are listed in ${options.vendor} index.`);
+
 const vendors = yaml.load(fs.readFileSync(options.vendor));
 
 if (!validateVendorsIndex(vendors)) {
@@ -212,7 +256,18 @@ console.log(`vendor index: valid`);
 
 const vendorProfiles = {};
 
+const vendorIDToValidate = options['vendor-id'];
+
+if (vendorIDToValidate && !vendors.vendors.some((v) => v.id === vendorIDToValidate)) {
+  console.error(`Specified vendor ID '${vendorIDToValidate}' does not exist in the repository.`);
+  process.exit(1);
+}
+
 vendors.vendors.forEach((v) => {
+  if (vendorIDToValidate && v.id !== vendorIDToValidate) {
+    return;
+  }
+
   const key = v.id;
   const folder = `./vendor/${v.id}`;
   if (v.logo) {
@@ -273,41 +328,71 @@ vendors.vendors.forEach((v) => {
           const regionProfile = version.profiles[region];
           const key = `${v.id}: ${d}: ${region}`;
           const vendorID = regionProfile.vendorID ?? v.id;
+
           if (!vendorProfiles[vendorID]) {
             vendorProfiles[vendorID] = {};
           }
+
           if (!vendorProfiles[vendorID][regionProfile.id]) {
             const profile = yaml.load(fs.readFileSync(`./vendor/${vendorID}/${regionProfile.id}.yaml`));
-            if (!validateEndDeviceProfile(profile)) {
-              console.error(
-                `${key}: profile ${vendorID}/${regionProfile.id} invalid: ${formatValidationErrors(
-                  validateEndDeviceProfile.errors
-                )}`
-              );
-              process.exit(1);
-            }
-          }
-          vendorProfiles[vendorID][regionProfile.id] = true;
-          console.log(`${key}: profile ${vendorID}/${regionProfile.id} valid`);
-
-          if (regionProfile.codec && !codecs[regionProfile.codec]) {
-            const codec = yaml.load(fs.readFileSync(`${folder}/${regionProfile.codec}.yaml`));
-            if (!validateEndDevicePayloadCodec(codec)) {
-              console.error(
-                `${key}: codec ${regionProfile.codec} invalid: ${formatValidationErrors(
-                  validateEndDevicePayloadCodec.errors
-                )}`
+
+            // Check if vendorProfileID is unique within the same company folder
+            if (profile.vendorProfileID !== undefined) {
+              const duplicateProfiles = Object.entries(vendorProfiles[vendorID]).filter(
+                ([profileId, existingProfile]) =>
+                  existingProfile.vendorProfileID === profile.vendorProfileID && profileId !== regionProfile.id
               );
-              process.exit(1);
+
+              if (duplicateProfiles.length > 0) {
+                const duplicateProfilePaths = duplicateProfiles.map(([duplicateProfileId, duplicateProfile]) => {
+                  return `${duplicateProfileId} (vendorProfileID: ${duplicateProfile.vendorProfileID})`;
+                });
+
+                console.error(
+                  `${key}: vendorProfileID ${
+                    profile.vendorProfileID
+                  } is not unique within ${vendorID} folder. Duplicate profiles found in: ${duplicateProfilePaths.join(
+                    ', '
+                  )}`
+                );
+                process.exit(1);
+              }
+
+              vendorProfiles[vendorID][regionProfile.id] = { vendorProfileID: profile.vendorProfileID };
+
+              if (!validateEndDeviceProfile(profile)) {
+                console.error(
+                  `${key}: profile ${vendorID}/${regionProfile.id} invalid: ${formatValidationErrors(
+                    validateEndDeviceProfile.errors
+                  )}`
+                );
+                process.exit(1);
+              }
+
+              console.log(`${key}: profile ${vendorID}/${regionProfile.id} valid`);
+            } else {
+              console.warn(`${key}: vendorProfileID is missing in ${vendorID}/${regionProfile.id}.yaml`);
             }
-            codecs[regionProfile.codec] = true;
-            await validatePayloadCodecs(folder, codec)
-              .then(() => console.log(`${key}: payload codec ${regionProfile.codec} valid`))
-              .catch((err) => {
-                console.error(`${key}: payload codec ${regionProfile.codec} invalid`);
-                console.error(err);
+
+            if (regionProfile.codec && !codecs[regionProfile.codec]) {
+              const codec = yaml.load(fs.readFileSync(`${folder}/${regionProfile.codec}.yaml`));
+              if (!validateEndDevicePayloadCodec(codec)) {
+                console.error(
+                  `${key}: codec ${regionProfile.codec} invalid: ${formatValidationErrors(
+                    validateEndDevicePayloadCodec.errors
+                  )}`
+                );
                 process.exit(1);
-              });
+              }
+              codecs[regionProfile.codec] = true;
+              await validatePayloadCodecs(folder, codec)
+                .then(() => console.log(`${key}: payload codec ${regionProfile.codec} valid`))
+                .catch((err) => {
+                  console.error(`${key}: payload codec ${regionProfile.codec} invalid`);
+                  console.error(err);
+                  process.exit(1);
+                });
+            }
           }
         });
       });

package.json

@@ -6,6 +6,7 @@
     "validate": "bin/validate.js"
   },
   "scripts": {
+    "prestart": "cp bin/pre-commit .git/hooks/ && chmod +x .git/hooks/pre-commit && echo 'hook copied'",
     "validate": "node bin/validate.js",
     "format": "prettier --write schema.json \"vendor/**/*.yaml\" \"bin/**/*.js\""
   },

vendor/abeeway/abeeway-compact-tracker-pro-eu868.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 1
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-compact-tracker-pro-us915.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 2
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-geolocation-module-profile.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 3
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-industrial-tracker-pro-as923.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 4
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-industrial-tracker-pro-eu868.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 5
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-industrial-tracker-pro-us915.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 6
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-micro-tracker-profile-as923.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 7
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-micro-tracker-profile-eu868.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 8
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-micro-tracker-profile-us915.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 9
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-smart-badge-profile-as923.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 10
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-smart-badge-profile-eu868.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 11
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/abeeway/abeeway-smart-badge-profile-us915.yaml

@@ -1,7 +1,7 @@
 # Vendor profile ID, can be freely issued by the vendor
 # This vendor profile ID is also used on the QR code for LoRaWAN devices, see
 # https://lora-alliance.org/sites/default/files/2020-10/LoRa_Alliance_Vendor_ID_for_QR_Code.pdf
-vendorProfileID: 0
+vendorProfileID: 12
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: 1.0.2

vendor/adeunis/adeunis-default-profile-c.yaml

@@ -1,4 +1,4 @@
-vendorProfileID: 16
+vendorProfileID: 1
 
 # LoRaWAN MAC version: 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4 or 1.1
 macVersion: '1.0.2'