Merge pull request #5003 from weichou1229/sched-refactor

refactor: Replace old Scheduler service with cron Scheduler service

.gitignore

@@ -25,10 +25,9 @@ cmd/security-file-token-provider/security-file-token-provider
 cmd/security-secretstore-setup/security-secretstore-setup
 cmd/support-logging/support-logging
 cmd/support-notifications/support-notifications
-cmd/support-cron-scheduler/support-cron-scheduler
+cmd/support-scheduler/support-scheduler
 cmd/secrets-config/secrets-config
 cmd/security-bootstrapper/security-bootstrapper
-cmd/security-proxy-auth/security-proxy-auth
 cmd/security-spiffe-token-provider/security-spiffe-token-provider
 
 docs/_build/

Makefile

@@ -28,7 +28,6 @@ DOCKERS= \
 	docker_core_keeper \
 	docker_support_notifications \
 	docker_support_scheduler \
-	docker_support_cron_scheduler \
 	docker_security_proxy_auth \
 	docker_security_proxy_setup \
 	docker_security_secretstore_setup \
@@ -47,7 +46,7 @@ MICROSERVICES= \
 	cmd/core-common-config-bootstrapper/core-common-config-bootstrapper \
 	cmd/core-keeper/core-keeper \
 	cmd/support-notifications/support-notifications \
-	cmd/support-cron-scheduler/support-cron-scheduler \
+	cmd/support-scheduler/support-scheduler \
 	cmd/security-proxy-auth/security-proxy-auth \
 	cmd/security-secretstore-setup/security-secretstore-setup \
 	cmd/security-file-token-provider/security-file-token-provider \
@@ -130,9 +129,9 @@ notifications: cmd/support-notifications/support-notifications
 cmd/support-notifications/support-notifications:
 	$(GO) build -tags "$(ADD_BUILD_TAGS) $(NON_DELAYED_START_GO_BUILD_TAG_FOR_SUPPORT)" $(GOFLAGS) -o $@ ./cmd/support-notifications
 
-cron-scheduler: cmd/support-cron-scheduler/support-cron-scheduler
-cmd/support-cron-scheduler/support-cron-scheduler:
-	$(GO) build -tags "$(ADD_BUILD_TAGS) $(NON_DELAYED_START_GO_BUILD_TAG_FOR_SUPPORT)" $(GOFLAGS) -o $@ ./cmd/support-cron-scheduler
+scheduler: cmd/support-scheduler/support-scheduler
+cmd/support-scheduler/support-scheduler:
+	$(GO) build -tags "$(ADD_BUILD_TAGS) $(NON_DELAYED_START_GO_BUILD_TAG_FOR_SUPPORT)" $(GOFLAGS) -o $@ ./cmd/support-scheduler
 
 proxy: cmd/security-proxy-setup/security-proxy-setup
 cmd/security-proxy-setup/security-proxy-setup:
@@ -271,7 +270,7 @@ docker_core_keeper: docker_base
 		-t edgexfoundry/core-keeper:$(DOCKER_TAG) \
 		.
 
-dsupport: dnotifications dscheduler dcronscheduler
+dsupport: dnotifications dscheduler dscheduler
 
 dnotifications: docker_support_notifications
 docker_support_notifications: docker_base
@@ -286,17 +285,17 @@ docker_support_notifications: docker_base
 		-t edgexfoundry/support-notifications:$(DOCKER_TAG) \
 		.
 
-dcronscheduler: docker_support_cron_scheduler
-docker_support_cron_scheduler: docker_base
+dscheduler: docker_support_scheduler
+docker_support_scheduler: docker_base
 	docker build \
 		--build-arg ADD_BUILD_TAGS=$(ADD_BUILD_TAGS) \
 		--build-arg http_proxy \
 		--build-arg https_proxy \
 		--build-arg BUILDER_BASE=$(LOCAL_CACHE_IMAGE) \
-		-f cmd/support-cron-scheduler/Dockerfile \
+		-f cmd/support-scheduler/Dockerfile \
 		--label "git_sha=$(GIT_SHA)" \
-		-t edgexfoundry/support-cron-scheduler:$(GIT_SHA) \
-		-t edgexfoundry/support-cron-scheduler:$(DOCKER_TAG) \
+		-t edgexfoundry/support-scheduler:$(GIT_SHA) \
+		-t edgexfoundry/support-scheduler:$(DOCKER_TAG) \
 		.
 
 dproxya: docker_security_proxy_auth

README.md

@@ -116,7 +116,7 @@ make docker
 
 #### Delayed Start Go Builds For Developers
 
-Currently for EdgeX core services except support services (support-notification and support-cron-scheduler services), the delayed start feature from the dependency go-mod-bootstrap / go-mod-secrets modules are excluded in go builds by default.
+Currently for EdgeX core services except support services (support-notification and support-scheduler services), the delayed start feature from the dependency go-mod-bootstrap / go-mod-secrets modules are excluded in go builds by default.
 If you want to **include** the delayed start feature in the builds for these services, please change the [Makefile in this directory](Makefile). In particular, change the following boolean flag from `false` to `true` before the whole docker builds.
 
 ```text

cmd/security-file-token-provider/res/token-config.json

@@ -35,7 +35,7 @@
   "device-rest": {
     "edgex_use_defaults": true
   },
-  "support-cron-scheduler": {
+  "support-scheduler": {
     "edgex_use_defaults": true
   },
   "security-proxy-auth": {

cmd/security-proxy-setup/entrypoint.sh

@@ -246,12 +246,12 @@ server {
       auth_request_set   \$auth_status \$upstream_status;
     }
 
-    set \$upstream_support_cron_scheduler edgex-support-cron-scheduler;
-    location /support-cron-scheduler {
+    set \$upstream_support_scheduler edgex-support-scheduler;
+    location /support-scheduler {
 `cat "${corssnippet}"`
-      rewrite            /support-cron-scheduler/(.*) /\$1 break;
+      rewrite            /support-scheduler/(.*) /\$1 break;
       resolver           127.0.0.11 valid=30s;
-      proxy_pass         http://\$upstream_support_cron_scheduler:59863;
+      proxy_pass         http://\$upstream_support_scheduler:59863;
       proxy_redirect     off;
       proxy_set_header   Host \$host;
       auth_request       /auth;

cmd/security-secretstore-setup/res/configuration.yaml

@@ -69,9 +69,9 @@ Databases:
   notifications:
     Service: support-notifications
     Username: support_notifications
-  cronscheduler:
-    Service: support-cron-scheduler
-    Username: support_cron_scheduler
+  scheduler:
+    Service: support-scheduler
+    Username: support_scheduler
 SecureMessageBus:
   Type: none
   KuiperConfigPath: /tmp/kuiper/edgex.yaml
@@ -89,5 +89,5 @@ SecureMessageBus:
       Service: app-rules-engine
     notifications:
       Service: support-notifications
-    cronscheduler:
-      Service: support-cron-scheduler
+    scheduler:
+      Service: support-scheduler

cmd/security-spire-config/seed_builtin_entries.sh

@@ -27,7 +27,7 @@ echo "SPIFFE_EDGEX_SVID_BASE=${SPIFFE_EDGEX_SVID_BASE}"
 
 echo "EDGEX_SPIFFE_CUSTOM_SERVICES=${EDGEX_SPIFFE_CUSTOM_SERVICES}"
 
-SPIFFE_SERVICES="security-spiffe-token-provider support-notifications support-cron-scheduler \
+SPIFFE_SERVICES="security-spiffe-token-provider support-notifications support-scheduler \
                  device-bacnet device-camera device-grove device-modbus device-mqtt device-rest device-snmp \
                  device-virtual device-rfid-llrp device-coap device-gpio \
                  app-http-export app-mqtt-export app-sample app-rfid-llrp-inventory \

cmd/support-cron-scheduler/Dockerfile → cmd/support-scheduler/Dockerfile

@@ -28,7 +28,7 @@ COPY go.mod vendor* ./
 RUN [ ! -d "vendor" ] && go mod download all || echo "skipping..."
 
 COPY . .
-RUN make cmd/support-cron-scheduler/support-cron-scheduler
+RUN make cmd/support-scheduler/support-scheduler
 
 FROM alpine:3.20
 
@@ -40,13 +40,13 @@ LABEL license='SPDX-License-Identifier: Apache-2.0' \
       copyright='Copyright (c) 2024: IOTech'
 
 ENV APP_PORT=59863
-#expose support cron scheduler port
+#expose support scheduler port
 EXPOSE $APP_PORT
 
 COPY --from=builder /edgex-go/Attribution.txt /
 COPY --from=builder /edgex-go/security.txt /
-COPY --from=builder /edgex-go/cmd/support-cron-scheduler/support-cron-scheduler /
-COPY --from=builder /edgex-go/cmd/support-cron-scheduler/res /res
+COPY --from=builder /edgex-go/cmd/support-scheduler/support-scheduler /
+COPY --from=builder /edgex-go/cmd/support-scheduler/res /res
 
-ENTRYPOINT ["/support-cron-scheduler"]
+ENTRYPOINT ["/support-scheduler"]
 CMD ["-cp=keeper.http://edgex-core-keeper:59890", "--registry"]

cmd/support-cron-scheduler/main.go → cmd/support-scheduler/main.go

@@ -17,12 +17,12 @@ package main
 import (
 	"context"
 
-	"github.com/edgexfoundry/edgex-go/internal/support/cronscheduler"
+	"github.com/edgexfoundry/edgex-go/internal/support/scheduler"
 
 	"github.com/labstack/echo/v4"
 )
 
 func main() {
 	ctx, cancel := context.WithCancel(context.Background())
-	cronscheduler.Main(ctx, cancel, echo.New())
+	scheduler.Main(ctx, cancel, echo.New())
 }

cmd/support-cron-scheduler/res/configuration.yaml → cmd/support-scheduler/res/configuration.yaml

@@ -10,7 +10,7 @@ Writable:
 Service:
   Host: localhost
   Port: 59863
-  StartupMsg: This is the Support Cron Scheduler Microservice
+  StartupMsg: This is the Support Scheduler Microservice
 
 Clients:
   core-command:
@@ -23,7 +23,7 @@ Clients:
 
 MessageBus:
   Optional:
-    ClientId: support-cron-scheduler
+    ClientId: support-scheduler
 
 Retention:
   Enabled: true

cmd/support-cron-scheduler/res/db/sql/00-utils.sql → cmd/support-scheduler/res/db/sql/00-utils.sql

@@ -4,4 +4,4 @@
 -- SPDX-License-Identifier: Apache-2.0
 
 -- schema for support_scheduler related tables
-CREATE SCHEMA IF NOT EXISTS support_cron_scheduler;
+CREATE SCHEMA IF NOT EXISTS support_scheduler;

cmd/support-cron-scheduler/res/db/sql/01-tables.sql → cmd/support-scheduler/res/db/sql/01-tables.sql

@@ -4,13 +4,13 @@
 -- SPDX-License-Identifier: Apache-2.0
 
 -- support_scheduler.job is used to store the schedule job information
-CREATE TABLE IF NOT EXISTS support_cron_scheduler.job (
+CREATE TABLE IF NOT EXISTS support_scheduler.job (
     id UUID PRIMARY KEY,
     content JSONB NOT NULL
 );
 
 -- support_scheduler.record is used to store the schedule action record
-CREATE TABLE IF NOT EXISTS support_cron_scheduler.record (
+CREATE TABLE IF NOT EXISTS support_scheduler.record (
     id UUID PRIMARY KEY,
     action_id UUID NOT NULL,
     job_name TEXT NOT NULL,

fuzz_test/Dockerfile.fuzz

@@ -39,7 +39,7 @@ ENTRYPOINT ["/restler-fuzzer/fuzzing.sh"]
 # This can take about 2 minutes to finish
 # You may swap out core-data to other server to perform fuzz-lean
 # docker run --net host --rm -v "$$PWD/fuzz_results:/fuzz_results" fuzz-edgex-go:latest core-data /restler-fuzzer/openapi/core-data.yaml"
-# Example: CMD of "all" will do fuzz-lean test for core-commmand, core-data, core-metadata, support-notifications, and support-cron-scheduler,
+# Example: CMD of "all" will do fuzz-lean test for core-commmand, core-data, core-metadata, support-notifications, and support-scheduler,
 # basically all services under openapi/v3/ directory
 # This can take more than 20 minutes to finish
 # docker run --net host --rm -v "$$PWD/fuzz_results:/fuzz_results" fuzz-edgex-go:latest all

fuzz_test/fuzzing_docker.sh

@@ -26,7 +26,7 @@ usage()
   echo "Usage:"
   echo "./fuzzing_docker.sh <EDGEX_PROJECT_NAME> <SWAGGER_FILE_NAME_PATH>"
   echo
-  echo "<EDGEX_PROJECT_NAME> is required, options: all|core-data|core-command|core-metadata|support-notifications|support-cron-scheduler"
+  echo "<EDGEX_PROJECT_NAME> is required, options: all|core-data|core-command|core-metadata|support-notifications|support-scheduler"
   echo "<SWAGGER_FILE_NAME_PATH> is required for NOT \"all\" EDGEX_PROJECT_NAME, it is the path and filename of a project swagger file"
   exit 1
 }

go.mod

@@ -4,11 +4,11 @@ go 1.23
 
 require (
 	github.com/eclipse/paho.mqtt.golang v1.5.0
-	github.com/edgexfoundry/go-mod-bootstrap/v4 v4.0.0-dev.5
+	github.com/edgexfoundry/go-mod-bootstrap/v4 v4.0.0-dev.8
 	github.com/edgexfoundry/go-mod-configuration/v4 v4.0.0-dev.4
-	github.com/edgexfoundry/go-mod-core-contracts/v4 v4.0.0-dev.4
+	github.com/edgexfoundry/go-mod-core-contracts/v4 v4.0.0-dev.5
 	github.com/edgexfoundry/go-mod-messaging/v4 v4.0.0-dev.5
-	github.com/edgexfoundry/go-mod-secrets/v4 v4.0.0-dev.3
+	github.com/edgexfoundry/go-mod-secrets/v4 v4.0.0-dev.4
 	github.com/fxamacker/cbor/v2 v2.7.0
 	github.com/go-co-op/gocron/v2 v2.12.3
 	github.com/gomodule/redigo v1.9.2
@@ -90,11 +90,11 @@ require (
 	github.com/oklog/ulid v1.3.1 // indirect
 	github.com/opentracing/opentracing-go v1.2.0 // indirect
 	github.com/openziti/channel/v3 v3.0.4 // indirect
-	github.com/openziti/edge-api v0.26.32 // indirect
+	github.com/openziti/edge-api v0.26.34 // indirect
 	github.com/openziti/foundation/v2 v2.0.49 // indirect
 	github.com/openziti/identity v1.0.85 // indirect
 	github.com/openziti/metrics v1.2.58 // indirect
-	github.com/openziti/sdk-golang v0.23.43 // indirect
+	github.com/openziti/sdk-golang v0.23.44 // indirect
 	github.com/openziti/secretstream v0.1.25 // indirect
 	github.com/openziti/transport/v2 v2.0.146 // indirect
 	github.com/orcaman/concurrent-map/v2 v2.0.1 // indirect

go.sum

@@ -68,18 +68,18 @@ github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/eclipse/paho.mqtt.golang v1.5.0 h1:EH+bUVJNgttidWFkLLVKaQPGmkTUfQQqjOsyvMGvD6o=
 github.com/eclipse/paho.mqtt.golang v1.5.0/go.mod h1:du/2qNQVqJf/Sqs4MEL77kR8QTqANF7XU7Fk0aOTAgk=
-github.com/edgexfoundry/go-mod-bootstrap/v4 v4.0.0-dev.5 h1:PRVpZco9lmvyE8bhatgkygi1EeTSgQx84CuXmEEIp3A=
-github.com/edgexfoundry/go-mod-bootstrap/v4 v4.0.0-dev.5/go.mod h1:KuxKgNdhxsuReOv8xYXReCWxrwtmAJZjjVGPRTzsG6Y=
+github.com/edgexfoundry/go-mod-bootstrap/v4 v4.0.0-dev.8 h1:uFy9gOVPCLIyYcHcyP8dWBiGPKBvLS+PfaHK9ab/Z9s=
+github.com/edgexfoundry/go-mod-bootstrap/v4 v4.0.0-dev.8/go.mod h1:IvrZ7zaD/0kvN+aAtqdudAPGOa4DprO4SDU3JQhVBUY=
 github.com/edgexfoundry/go-mod-configuration/v4 v4.0.0-dev.4 h1:Bw8Bxoc2LjAfkgWvAQtbeqnAaGPmKiCoAHlHGalhnv4=
 github.com/edgexfoundry/go-mod-configuration/v4 v4.0.0-dev.4/go.mod h1:Jc8kjQTAUYzuHbQzRuVzfPZy3QfJGMQ0rGHOhRit7to=
-github.com/edgexfoundry/go-mod-core-contracts/v4 v4.0.0-dev.4 h1:MrGBXxpgpL0TGMjXXh2E85pUwrUiqB/vgDq8SKztFrk=
-github.com/edgexfoundry/go-mod-core-contracts/v4 v4.0.0-dev.4/go.mod h1:I3EG+Tg/gcVSUJ+IJDuvVKFISnRu8oQtMXqltE1rzT8=
+github.com/edgexfoundry/go-mod-core-contracts/v4 v4.0.0-dev.5 h1:PHcgm730GAjl8hR5y25OE+YEe6urZhYIcIYGY7TeCWM=
+github.com/edgexfoundry/go-mod-core-contracts/v4 v4.0.0-dev.5/go.mod h1:I3EG+Tg/gcVSUJ+IJDuvVKFISnRu8oQtMXqltE1rzT8=
 github.com/edgexfoundry/go-mod-messaging/v4 v4.0.0-dev.5 h1:DSk5kr4NZx+0Tbdb6vrnD2YNRX70nllgKceYCOTeSDo=
 github.com/edgexfoundry/go-mod-messaging/v4 v4.0.0-dev.5/go.mod h1:5RZ2zfycHLKjMDGD+uvGf+bazEs75EG/FM1RTvFG23M=
 github.com/edgexfoundry/go-mod-registry/v4 v4.0.0-dev.2 h1:iHu8JPpmrEOrIZdv0iYW69FlMmkyal/FpbXtC3pHt2c=
 github.com/edgexfoundry/go-mod-registry/v4 v4.0.0-dev.2/go.mod h1:0qsKMZkTP3jE0GisaNcMjn6euhAIVEFPy4WXbjgzgD0=
-github.com/edgexfoundry/go-mod-secrets/v4 v4.0.0-dev.3 h1:iMo7uwjAkFpYyLL9PXNbiGrtDunpXqE/mBalGlzECaY=
-github.com/edgexfoundry/go-mod-secrets/v4 v4.0.0-dev.3/go.mod h1:Xy9fwi+q7KkYsKehcDuxU2gvIVU4ZYljtqJVgq5/5Ho=
+github.com/edgexfoundry/go-mod-secrets/v4 v4.0.0-dev.4 h1:3YPeukLHkgDEG7dCWYosTNuqOoQHrVFVt65/LlG4LlQ=
+github.com/edgexfoundry/go-mod-secrets/v4 v4.0.0-dev.4/go.mod h1:6P6KEOfPuzy8lXBkYCWTg7ZCHCJXL3ijYnkJQMEGvvc=
 github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
 github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ=
 github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
@@ -379,16 +379,16 @@ github.com/opentracing/opentracing-go v1.2.0 h1:uEJPy/1a5RIPAJ0Ov+OIO8OxWu77jEv+
 github.com/opentracing/opentracing-go v1.2.0/go.mod h1:GxEUsuufX4nBwe+T+Wl9TAgYrxe9dPLANfrWvHYVTgc=
 github.com/openziti/channel/v3 v3.0.4 h1:1A2HH9fVT5xq3G2Fy20L/5ZbpmFzbXfY7CEq6vQnbI0=
 github.com/openziti/channel/v3 v3.0.4/go.mod h1:MiVIlcPpcErv8E/TLDpxWNV1fGh8lb0g7qMlQGFYTec=
-github.com/openziti/edge-api v0.26.32 h1:32oJI97cuM/kRJPEOwH2pe9dqwj56IYdQgTjTJaaHaU=
-github.com/openziti/edge-api v0.26.32/go.mod h1:sYHVpm26Jr1u7VooNJzTb2b2nGSlmCHMnbGC8XfWSng=
+github.com/openziti/edge-api v0.26.34 h1:73OcSpEeE2pdLKxPH2cGwDi8YcROWRGJfR+BAFRPGIE=
+github.com/openziti/edge-api v0.26.34/go.mod h1:sYHVpm26Jr1u7VooNJzTb2b2nGSlmCHMnbGC8XfWSng=
 github.com/openziti/foundation/v2 v2.0.49 h1:aQ5I/lMhkHQ6urhRpLwrWP+7YtoeUitCfY/wub+nOqo=
 github.com/openziti/foundation/v2 v2.0.49/go.mod h1:tFk7wg5WE/nDDur5jSVQTROugKDXQkFvmqRSV4pvWp0=
 github.com/openziti/identity v1.0.85 h1:jphDHrUCXCJGdbVTMBqsdtS0Ei/vhDH337DMNMYzLro=
 github.com/openziti/identity v1.0.85/go.mod h1:beIXWNDImEjZn93XPOorJzyuQCQUYOvKFQ0fWhLN2qM=
 github.com/openziti/metrics v1.2.58 h1:AbHSTMKHP/o6r6fh7a08c486Y/5f5xjkZQbcyn3w1tM=
 github.com/openziti/metrics v1.2.58/go.mod h1:zGLMrLvVFOxo9tXUf8svcUsASxsPjhW9foW92FUzmDs=
-github.com/openziti/sdk-golang v0.23.43 h1:n/Xaif9canea+T+VgNmfNhF2nNveXe4gdS35uUQgUIY=
-github.com/openziti/sdk-golang v0.23.43/go.mod h1:6QsDMxGxX3Qsgpp4zVVHgBfr5XkXjIwRONS7onnaGvU=
+github.com/openziti/sdk-golang v0.23.44 h1:TzRO8dz6aAO2g0IXsKC6PvmT+cYyJpw2oJRUqhnPeCA=
+github.com/openziti/sdk-golang v0.23.44/go.mod h1:tJ8KXdqWRfAEekvbo/vJsN2PYydbPK/Gh2rAcc65+qE=
 github.com/openziti/secretstream v0.1.25 h1:40gHKcAcoXqKs0J7Tz1jTAmPoMXmMn4HP3Mg6scgJ5c=
 github.com/openziti/secretstream v0.1.25/go.mod h1:zgBcyN7h/zLBIWeqSrWwlOGOMQW51oQGYYlkiArR6Ec=
 github.com/openziti/transport/v2 v2.0.146 h1:Wdr4udri/fFpdj9GR9DR7/FKqt/2cMTgBdt3gfrqFaQ=

internal/pkg/infrastructure/postgres/client_test.go

@@ -6,8 +6,8 @@
 package postgres
 
 import (
-	cronSchedulerInterfaces "github.com/edgexfoundry/edgex-go/internal/support/cronscheduler/infrastructure/interfaces"
+	schedulerInterfaces "github.com/edgexfoundry/edgex-go/internal/support/scheduler/infrastructure/interfaces"
 )
 
 // Check the implementation of Postgres satisfies the DB client
-var _ cronSchedulerInterfaces.DBClient = &Client{}
+var _ schedulerInterfaces.DBClient = &Client{}

internal/pkg/infrastructure/postgres/consts.go

@@ -11,7 +11,7 @@ const (
 	coreKeeperSchema           = "core_keeper"
 	coreMetaDataSchema         = "core_metadata"
 	supportNotificationsSchema = "support_notifications"
-	supportSchedulerSchema     = "support_cron_scheduler"
+	supportSchedulerSchema     = "support_scheduler"
 )
 
 // constants relate to the postgres db table names