support resources-path (#1012)

* support spec-resources-path

Signed-off-by: HueiFeng <[email protected]>

* Update resource-path

Signed-off-by: hueifeng <[email protected]>

* Update resource-path

Signed-off-by: hueifeng <[email protected]>

* fix

Signed-off-by: hueifeng <[email protected]>

* added deprecation message and e2e tests

Signed-off-by: Pravin Pushkar <[email protected]>

* added messages in readme for deprecation and use of resource-path

Signed-off-by: Pravin Pushkar <[email protected]>

* fix lint and failing test case

Signed-off-by: Pravin Pushkar <[email protected]>

Signed-off-by: HueiFeng <[email protected]>
Signed-off-by: hueifeng <[email protected]>
Signed-off-by: Pravin Pushkar <[email protected]>
Co-authored-by: Mukundan Sundararajan <[email protected]>
Co-authored-by: Yaron Schneider <[email protected]>
Co-authored-by: Shubham Sharma <[email protected]>
Co-authored-by: Pravin Pushkar <[email protected]>

Author: 5 people

README.md

@@ -99,7 +99,7 @@ Output should look like so:
 
 This step creates the following defaults:
 
-1. components folder which is later used during `dapr run` unless the `--components-path` option is provided. For Linux/MacOS, the default components folder path is `$HOME/.dapr/components` and for Windows it is `%USERPROFILE%\.dapr\components`.
+1. components folder which is later used during `dapr run` unless the `--resources-path` (`--components-path` is deprecated and will be removed in future releases) option is provided. For Linux/MacOS, the default components folder path is `$HOME/.dapr/components` and for Windows it is `%USERPROFILE%\.dapr\components`.
 2. component files in the components folder called `pubsub.yaml` and `statestore.yaml`.
 3. default config file `$HOME/.dapr/config.yaml` for Linux/MacOS or for Windows at `%USERPROFILE%\.dapr\config.yaml` to enable tracing on `dapr init` call. Can be overridden with the `--config` flag on `dapr run`.
 
@@ -121,7 +121,7 @@ Output should look like so:
 ✅  Success! Dapr is up and running. To get started, go here: https://aka.ms/dapr-getting-started
 ```
 
->Note: When initializing Dapr with the `--slim` flag only the Dapr runtime binary and the placement service binary are installed. An empty default components folder is created with no default configuration files. During `dapr run` user should use `--components-path` to point to a components directory with custom configurations files or alternatively place these files in the default directory. For Linux/MacOS, the default components directory path is `$HOME/.dapr/components` and for Windows it is `%USERPROFILE%\.dapr\components`.
+>Note: When initializing Dapr with the `--slim` flag only the Dapr runtime binary and the placement service binary are installed. An empty default components folder is created with no default configuration files. During `dapr run` user should use `--resources-path` (`--components-path` is deprecated and will be removed in future releases) to point to a components directory with custom configurations files or alternatively place these files in the default directory. For Linux/MacOS, the default components directory path is `$HOME/.dapr/components` and for Windows it is `%USERPROFILE%\.dapr\components`.
 
 #### Install a specific runtime version
 
@@ -444,7 +444,7 @@ Launch Dapr and your app:
 dapr run --app-id nodeapp --app-port 3000 node app.js
 ```
 
-Note: To choose a non-default components folder, use the --components-path option.
+Note: To choose a non-default components folder, use the --resources-path(--components-path is deprecated) option.
 
 Invoke your app:
 
@@ -561,7 +561,8 @@ dapr components --kubernetes --namespace target-namespace
 To use a custom path for component definitions
 
 ```bash
-dapr run --components-path [custom path]
+dapr run --resources-path [custom path]
+> Note: --components-path flag is deprecated. It will continue to work until it is removed completely.
 ```
 
 

cmd/run.go

@@ -44,6 +44,7 @@ var (
 	logLevel           string
 	protocol           string
 	componentsPath     string
+	resourcesPath      string
 	appSSL             bool
 	metricsPort        int
 	maxRequestBodySize int
@@ -120,6 +121,7 @@ dapr run --app-id myapp --app-port 3000 --app-protocol grpc -- go run main.go
 			Protocol:           protocol,
 			PlacementHostAddr:  viper.GetString("placement-host-address"),
 			ComponentsPath:     componentsPath,
+			ResourcesPath:      resourcesPath,
 			AppSSL:             appSSL,
 			MetricsPort:        metricsPort,
 			MaxRequestBodySize: maxRequestBodySize,
@@ -376,6 +378,10 @@ func init() {
 	RunCmd.Flags().IntVarP(&maxConcurrency, "app-max-concurrency", "", -1, "The concurrency level of the application, otherwise is unlimited")
 	RunCmd.Flags().StringVarP(&protocol, "app-protocol", "P", "http", "The protocol (gRPC or HTTP) Dapr uses to talk to the application")
 	RunCmd.Flags().StringVarP(&componentsPath, "components-path", "d", standalone.DefaultComponentsDirPath(), "The path for components directory")
+	RunCmd.Flags().StringVarP(&resourcesPath, "resources-path", "", "", "The path for resources directory")
+	// TODO: Remove below line once the flag is removed in the future releases.
+	// By marking this as deprecated, the flag will be hidden from the help menu, but will continue to work. It will show a warning message when used.
+	RunCmd.Flags().MarkDeprecated("components-path", "This flag is deprecated and will be removed in the future releases. Use \"resources-path\" flag instead")
 	RunCmd.Flags().String("placement-host-address", "localhost", "The address of the placement service. Format is either <hostname> for default port or <hostname>:<port> for custom port")
 	RunCmd.Flags().BoolVar(&appSSL, "app-ssl", false, "Enable https when Dapr invokes the application")
 	RunCmd.Flags().IntVarP(&metricsPort, "metrics-port", "M", -1, "The port of metrics on dapr")

pkg/standalone/run.go

@@ -49,6 +49,7 @@ type RunConfig struct {
 	MaxConcurrency     int    `arg:"app-max-concurrency"`
 	PlacementHostAddr  string `arg:"placement-host-address"`
 	ComponentsPath     string `arg:"components-path"`
+	ResourcesPath      string `arg:"resources-path"`
 	AppSSL             bool   `arg:"app-ssl"`
 	MetricsPort        int    `env:"DAPR_METRICS_PORT" arg:"metrics-port"`
 	MaxRequestBodySize int    `arg:"dapr-http-max-request-size"`
@@ -132,6 +133,10 @@ func (config *RunConfig) validate() error {
 		return err
 	}
 
+	if config.ResourcesPath != "" {
+		config.ComponentsPath = ""
+	}
+
 	if config.AppPort < 0 {
 		config.AppPort = 0
 	}
@@ -231,6 +236,7 @@ func newDaprMeta() (*DaprMeta, error) {
 
 func (config *RunConfig) getArgs() []string {
 	args := []string{}
+
 	schema := reflect.ValueOf(*config)
 	for i := 0; i < schema.NumField(); i++ {
 		valueField := schema.Field(i).Interface()
@@ -255,6 +261,7 @@ func (config *RunConfig) getArgs() []string {
 			}
 		}
 	}
+
 	if config.ConfigFile != "" {
 		sentryAddress := mtlsEndpoint(config.ConfigFile)
 		if sentryAddress != "" {
@@ -266,7 +273,6 @@ func (config *RunConfig) getArgs() []string {
 	if print.IsJSONLogEnabled() {
 		args = append(args, "--log-as-json")
 	}
-
 	return args
 }
 

tests/e2e/standalone/run_test.go

@@ -121,6 +121,32 @@ func TestStandaloneRun(t *testing.T) {
 		assert.Contains(t, output, "Exited Dapr successfully")
 	})
 
+	t.Run(fmt.Sprintf("check run with resources-path flag"), func(t *testing.T) {
+		args := []string{
+			"--app-id", "testapp",
+			"--resources-path", "../testdata/nonexistentdir",
+			"--", "bash", "-c", "echo 'test'",
+		}
+		output, err := cmdRun("", args...)
+		t.Log(output)
+		require.NoError(t, err, "run failed")
+		assert.Contains(t, output, "failed to load components: open ../testdata/nonexistentdir:")
+		assert.Contains(t, output, "Exited App successfully")
+		assert.Contains(t, output, "Exited Dapr successfully")
+
+		args = []string{
+			"--app-id", "testapp",
+			"--resources-path", "../testdata/resources",
+			"--", "bash", "-c", "echo 'test'",
+		}
+		output, err = cmdRun("", args...)
+		t.Log(output)
+		require.NoError(t, err, "run failed")
+		assert.Contains(t, output, "component loaded. name: test-statestore, type: state.in-memory/v1")
+		assert.Contains(t, output, "Exited App successfully")
+		assert.Contains(t, output, "Exited Dapr successfully")
+	})
+
 	t.Run("run with unknown flags", func(t *testing.T) {
 		output, err := cmdRun("", "--flag")
 		require.Error(t, err, "expected error on run unknown flag")

tests/e2e/testdata/resources/test-statestore.yaml

@@ -0,0 +1,8 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: test-statestore
+spec:
+  type: state.in-memory
+  version: v1
+  metadata: