Development

.github/dependabot.yml

@@ -5,9 +5,12 @@
 
 version: 2
 updates:
-#
+
+###############################################################################
+###############################################################################
 # Core components
-#
+###############################################################################
+###############################################################################
 
   # Core API
   - package-ecosystem: "gradle"
@@ -48,10 +51,12 @@ updates:
     labels:
       - "area-dependencies"
       - "project-core-baseStation"
-
-#
+
+###############################################################################
+###############################################################################
 # Libraries
-#
+###############################################################################
+###############################################################################
 
   # Core API Lib Quarkus
   - package-ecosystem: "gradle"
@@ -62,12 +67,16 @@ updates:
       day: "tuesday"
     labels:
       - "area-dependencies"
-
-#
+
+###############################################################################
+###############################################################################
 # Plugins
-#
+###############################################################################
+###############################################################################
 
+  #
   # External Item Search
+  #
   - package-ecosystem: "gradle"
     directory: "/software/plugins/external-item-search"
     target-branch: "development"
@@ -76,7 +85,21 @@ updates:
       day: "tuesday"
     labels:
       - "area-dependencies"
+      - "project-plugin-extItemSearch"
+  -
+    package-ecosystem: "docker"
+    directory: "/software/plugins/external-item-search/src/main/docker"
+    target-branch: "development"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+    labels:
+      - "area-dependencies"
+      - "project-plugin-extItemSearch"
+
+  #
   # Mss Controller
+  #
   - package-ecosystem: "gradle"
     directory: "/software/plugins/mss-controller"
     target-branch: "development"
@@ -85,7 +108,10 @@ updates:
       day: "tuesday"
     labels:
       - "area-dependencies"
+
+  #
   # Storagotchi
+  #
   - package-ecosystem: "gradle"
     directory: "/software/plugins/storagotchi"
     target-branch: "development"
@@ -103,15 +129,4 @@ updates:
       day: "tuesday"
     labels:
       - "area-dependencies"
-      - "project-core-api"
-
-  # Demo
-#  - package-ecosystem: "gradle"
-#    directory: "/software/plugins/open-qm-plugin-demo"
-#    target-branch: "dev"
-#    schedule:
-#      interval: "weekly"
-#    labels:
-#      - "area-dependencies"
-#      - "project-plugins"
-
+      - "project-plugin-storagotchi"

.github/workflows/plugin-extItemSearch.yml

@@ -1,41 +1,22 @@
 name: CI - Plugin - External Item Search
 
-# Controls when the workflow will run
 on:
-  # Triggers the workflow on push or pull request events but only for the main branch
-  push:
-    branches: [ "**" ]
-    paths:
-      - "software/plugins/external-item-search/**"
-      - ".github/workflows/plugin-extItemSearch.yml"
   pull_request:
-    branches: [ "**" ]
     paths:
       - "software/plugins/external-item-search/**"
       - ".github/workflows/plugin-extItemSearch.yml"
   workflow_call:
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-defaults:
-  run:
-    working-directory: "software/plugins/external-item-search/"
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+
+concurrency:
+  group: ci-plugin-extItemSearch-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  build:
-    uses: ./.github/workflows/wf-gradleBuild.yaml
+  CI-Pipeline:
+    uses: Epic-Breakfast-Productions/ebp-ci/.github/workflows/quarkus-ci-pipeline.yml@main
     with:
       path: "software/plugins/external-item-search/"
-  unitTest:
-    uses: ./.github/workflows/wf-gradleUnitTest.yaml
-    with:
-      path: "software/plugins/external-item-search/"
-  intTest:
-    uses: ./.github/workflows/wf-gradleQuarkusIntTest.yaml
-    strategy:
-      matrix:
-        containerBased: [ false ] # TODO:: enable true
-    with:
-      path: "software/plugins/external-item-search/"
-      containerBased: ${{ matrix.containerBased }}
-
-
+      java-version: "25"
+      run-int-tests: true
+      container-based-int-tests: true

deployment/Single Host/Station-Captain/src/lib/ConfigManager.py

@@ -230,7 +230,7 @@ def __init__(
 
     def rereadConfigData(self):
         self.configData = self.readFile(self.mainConfigFile)
-        for file in os.listdir(self.additionalConfigsDir):
+        for file in sorted(os.listdir(self.additionalConfigsDir)):
             if file.endswith(".json"):
                 curUpdates = self.readFile(self.additionalConfigsDir + "/" + file)
                 self.configData = ConfigManager.mergeDicts(self.configData, curUpdates)

deployment/Single Host/Station-Captain/src/oqm-config.py

@@ -138,9 +138,9 @@ def set(args):
 
     if secret:
         json = mainCM.setSecretValInFile(
-            configKeyToSet=args.setSecret[0],
-            configValToSet=args.setSecret[1],
-            configFile=args.setSecret[2]
+            configKeyToSet=configKeyToSet,
+            configValToSet=configValToSet,
+            configFile=configFile
         )
     else:
         json = mainCM.setConfigValInFile(

docs/development/developmentFlow.md

@@ -14,3 +14,15 @@ Branches:
   - final review into `main`
 - `dev/[issue #]-[issue name]`
   - where work happens
+
+## Github Project
+
+https://github.com/orgs/Epic-Breakfast-Productions/projects/8
+
+All issues are to be assigned to the OQM github project for tracking purposes. We use the features of the project interface to track issues, assign them to team members, and manage workflows.
+
+## Labels
+
+https://github.com/Epic-Breakfast-Productions/OpenQuarterMaster/labels
+
+Labels help us categorize and organize issues. These should be accurate and applied as relevant.

software/core/oqm-core-api/build.gradle

@@ -1,7 +1,7 @@
 plugins {
 	id 'java'
 	id 'io.quarkus'
-	id "io.freefair.lombok" version "9.2.0"
+	id "io.freefair.lombok" version "9.4.0"
 	id 'jacoco'
 	id 'org.cyclonedx.bom' version '3.2.4'
 	id("org.spdx.sbom") version "0.10.0"

software/core/oqm-core-api/gradle.properties

@@ -1,7 +1,7 @@
 #Gradle properties
 quarkusPluginId=io.quarkus
-quarkusPluginVersion=3.34.2
-quarkusPlatformVersion=3.34.2
+quarkusPluginVersion=3.34.6
+quarkusPlatformVersion=3.34.6
 quarkusPlatformGroupId=io.quarkus
 quarkusPlatformArtifactId=quarkus-universe-bom
 org.gradle.logging.level=INFO

software/core/oqm-core-base-station/build.gradle

@@ -1,11 +1,11 @@
 plugins {
     id 'java'
     id 'io.quarkus'
-    id "io.freefair.lombok" version "9.2.0"
+    id "io.freefair.lombok" version "9.4.0"
 }
 
 group 'com.ebp.openQuarterMaster'
-version '1.15.4'
+version '1.15.5-SNAPSHOT'
 
 repositories {
     mavenCentral()
@@ -31,7 +31,7 @@ dependencies {
     implementation 'io.quarkus:quarkus-micrometer-opentelemetry'
     implementation 'io.quarkus:quarkus-scheduler'
 
-    implementation 'tech.epic-breakfast-productions.openquartermaster.lib.core:core-api-lib-quarkus:4.4.5'
+    implementation 'tech.epic-breakfast-productions.openquartermaster.lib.core:core-api-lib-quarkus:4.4.6-SNAPSHOT'
 
     implementation 'org.apache.commons:commons-io:1.3.2'
     implementation 'org.apache.commons:commons-text:1.15.0'
@@ -49,7 +49,7 @@ dependencies {
     testImplementation 'net.datafaker:datafaker:2.5.4'
 
     testImplementation 'com.microsoft.playwright:playwright:1.59.0'
-    testImplementation 'com.deque.html.axe-core:playwright:4.11.1'
+    testImplementation 'com.deque.html.axe-core:playwright:4.11.2'
 }
 
 java {

software/core/oqm-core-base-station/gradle.properties

@@ -1,6 +1,6 @@
 #Gradle properties
 quarkusPluginId=io.quarkus
-quarkusPluginVersion=3.32.4
-quarkusPlatformVersion=3.32.4
+quarkusPluginVersion=3.34.6
+quarkusPlatformVersion=3.34.6
 quarkusPlatformGroupId=io.quarkus.platform
 quarkusPlatformArtifactId=quarkus-bom

software/core/oqm-core-base-station/src/main/java/tech/ebp/oqm/core/baseStation/interfaces/rest/passthrough/plugins/externalItemSearch/ItemLookupRestInterface.java

@@ -1,23 +1,29 @@
 package tech.ebp.oqm.core.baseStation.interfaces.rest.passthrough.plugins.externalItemSearch;
 
-import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.quarkus.security.Authenticated;
 import io.smallrye.mutiny.Uni;
-import jakarta.annotation.security.PermitAll;
 import jakarta.enterprise.context.RequestScoped;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import jakarta.ws.rs.BeanParam;
+import jakarta.ws.rs.DefaultValue;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
-import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
+import lombok.NonNull;
 import lombok.extern.slf4j.Slf4j;
+import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
 import org.eclipse.microprofile.openapi.annotations.tags.Tag;
 import org.eclipse.microprofile.openapi.annotations.tags.Tags;
 import org.eclipse.microprofile.rest.client.inject.RestClient;
 import tech.ebp.oqm.core.baseStation.interfaces.rest.passthrough.PassthroughProvider;
 import tech.ebp.oqm.core.baseStation.service.ExternalItemSearchClient;
 
+import java.util.List;
+
 @Slf4j
 @Path(PassthroughProvider.PASSTHROUGH_API_PLUGIN_ROOT + "/itemLookup")
 @Tags({@Tag(name = "External Item Lookup", description = "Endpoints for searching for items from other places.")})
@@ -29,44 +35,40 @@ public class ItemLookupRestInterface extends PassthroughProvider {
 	ExternalItemSearchClient externalItemSearchClient;
 
 	@GET
-	@Path("/providers")
+	@Path("/search")
 	@Produces(MediaType.APPLICATION_JSON)
-	public Uni<Response> allProviderInfo() {
+	public Uni<Response> search(@BeanParam ItemLookupRequest request) {
 		return this.handleCall(
-			this.externalItemSearchClient.allProviderInfo()
+			this.externalItemSearchClient.search(request)
 		);
 	}
 
-	@GET
-	@Path("barcode/{barcode}")
-	@Produces(MediaType.APPLICATION_JSON)
-	public Uni<Response> searchBarcode(
-		@PathParam("barcode") String barcode
-	) {
-		return this.handleCall(
-			this.externalItemSearchClient.searchBarcode(barcode)
-		);
-	}
-
-	@GET
-	@Path("webpage-scrape/{webpage}")
-	@Produces(MediaType.APPLICATION_JSON)
-	public Uni<Response> scanWebpage(
-		@PathParam("webpage") String page
-	) {
-		return this.handleCall(
-			this.externalItemSearchClient.scanWebpage(page)
-		);
-	}
-
-	@GET
-	@Path("lego/part/{partNo}")
-	@Produces(MediaType.APPLICATION_JSON)
-	public Uni<Response> searchLegoPart(
-		@PathParam("partNo") String partNo
-	) {
-		return this.handleCall(
-			this.externalItemSearchClient.searchLegoPart(partNo)
-		);
+	public static class ItemLookupRequest {
+
+		@Parameter(description = "The type of lookup to perform. If empty, will perform a text search.")
+		@QueryParam("lookupMethod")
+		@DefaultValue("TEXT")
+		List<String> lookupMethods;
+
+		@Parameter(description = "The data source(s) to use to search. If empty, any are used.")
+		@QueryParam("service")
+		List<String> services;
+
+		@Parameter(
+			description = "The source(s) to use to search. Distinct from 'services', as some sources can pull from many services. Example, one service might present data from Amazon,"
+						  + " and other retailers. If empty, will search all available."
+		)
+		@QueryParam("source")
+		List<String> sources;
+
+		@NonNull
+		@NotNull
+		@NotBlank
+		@QueryParam("q")
+		String search;
+
+		@QueryParam("keepNotFound")
+		@DefaultValue("false")
+		boolean keepNotFound;
 	}
 }

software/core/oqm-core-base-station/src/main/java/tech/ebp/oqm/core/baseStation/interfaces/ui/pages/HelpUi.java

@@ -55,10 +55,11 @@ public Uni<Response> overview() throws MalformedURLException {
 				"unitCategoryMap", this.coreApiClient.unitGetAll(this.getBearerHeaderStr()),
 				"extSearchEnabled", Uni.createFrom().item(extSearchEnabled),
 				"allProviderInfo", extSearchEnabled ?
-					QuarkusRestClientBuilder.newBuilder()
-						.baseUrl(new URL(this.extSearchUrl))
-						.build(ExternalItemSearchClient.class).allProviderInfo()
-					: Uni.createFrom().nullItem()
+									   QuarkusRestClientBuilder.newBuilder()
+										   .baseUrl(new URL(this.extSearchUrl))
+										   .build(ExternalItemSearchClient.class).allProviderInfo()
+									   : Uni.createFrom().nullItem()
+
 			)
 		);
 	}