Deprecate --build-properties flag in favor of --build-property

Author: silvanocerza

Diff for: cli/compile/compile.go

@@ -57,12 +57,16 @@ var (
 // NewCommand created a new `compile` command
 func NewCommand() *cobra.Command {
 	command := &cobra.Command{
-		Use:     "compile",
-		Short:   "Compiles Arduino sketches.",
-		Long:    "Compiles Arduino sketches.",
-		Example: "  " + os.Args[0] + " compile -b arduino:avr:uno /home/user/Arduino/MySketch",
-		Args:    cobra.MaximumNArgs(1),
-		Run:     run,
+		Use:   "compile",
+		Short: "Compiles Arduino sketches.",
+		Long:  "Compiles Arduino sketches.",
+		Example: "" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno /home/user/Arduino/MySketch\n" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno --build-property='build.extra_flags=\"-DMY_DEFINE=\"hello world\"\"' /home/user/Arduino/MySketch\n" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno --build-property='build.extra_flags=-DPIN=2 \"-DMY_DEFINE=\"hello world\"\"' /home/user/Arduino/MySketch\n" +
+			"  " + os.Args[0] + " compile -b arduino:avr:uno --build-property=build.extra_flags=-DPIN=2 --build-property='compiler.cpp.extra_flags=\"-DSSID=\"hello world\"\"'-DMY_DEFINE=\"hello world\"' /home/user/Arduino/MySketch\n",
+		Args: cobra.MaximumNArgs(1),
+		Run:  run,
 	}
 
 	command.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
@@ -73,8 +77,10 @@ func NewCommand() *cobra.Command {
 	command.Flags().BoolVarP(&dryRun, "dry-run", "n", false, "Perform the build but do not copy the compile output file.")
 	command.Flags().StringVar(&buildPath, "build-path", "",
 		"Path where to save compiled files. If omitted, a directory will be created in the default temporary path of your OS.")
-	command.Flags().StringArrayVar(&buildProperties, "build-properties", []string{},
-		"List of custom build properties separated by spaces. Or can be used multiple times for multiple properties.")
+	command.Flags().StringSliceVar(&buildProperties, "build-properties", []string{},
+		"List of custom build properties separated by commas. Or can be used multiple times for multiple properties.")
+	command.Flags().StringArrayVar(&buildProperties, "build-property", []string{},
+		"Override a build property with a custom value. Can be used multiple times for multiple properties.")
 	command.Flags().StringVar(&warnings, "warnings", "none",
 		`Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag).`)
 	command.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
@@ -89,6 +95,8 @@ func NewCommand() *cobra.Command {
 	command.Flags().StringVarP(&programmer, "programmer", "P", "", "Optional, use the specified programmer to upload.")
 	command.Flags().BoolVar(&clean, "clean", false, "Optional, cleanup the build folder and do not use any cached build.")
 
+	command.Flags().MarkDeprecated("build-properties", "please use --build-property instead.")
+
 	return command
 }
 

Diff for: test/test_compile.py

@@ -235,27 +235,78 @@ def test_compile_without_precompiled_libraries(run_command, data_dir):
     assert result.ok
 
 
-def test_compile_with_build_property_containing_quotes(run_command, data_dir, copy_sketch):
+def test_compile_with_build_properties_flag(run_command, data_dir, copy_sketch):
     # Init the environment explicitly
     assert run_command("core update-index")
 
     # Install Arduino AVR Boards
     assert run_command("core install arduino:[email protected]")
 
-    sketch_path = copy_sketch("sketch_with_single_define")
+    sketch_path = copy_sketch("sketch_with_single_string_define")
     fqbn = "arduino:avr:uno"
 
-    # Compile using a build property with an equal
+    # Compile using a build property with quotes
     res = run_command(
         f"compile -b {fqbn} "
         + '--build-properties="build.extra_flags=\\"-DMY_DEFINE=\\"hello world\\"\\"" '
+        + f"{sketch_path} --verbose --clean"
+    )
+    assert res.failed
+    assert "Flag --build-properties has been deprecated, please use --build-property instead." not in res.stderr
+
+    # Try again with quotes
+    res = run_command(
+        f"compile -b {fqbn} "
+        + '--build-properties="build.extra_flags=-DMY_DEFINE=\\"hello\\"" '
+        + f"{sketch_path} --verbose --clean"
+    )
+    assert res.failed
+    assert "Flag --build-properties has been deprecated, please use --build-property instead." not in res.stderr
+
+    # Try without quotes
+    sketch_path = copy_sketch("sketch_with_single_int_define")
+    res = run_command(
+        f"compile -b {fqbn} "
+        + '--build-properties="build.extra_flags=-DMY_DEFINE=1" '
+        + f"{sketch_path} --verbose --clean"
+    )
+    assert res.ok
+    assert "Flag --build-properties has been deprecated, please use --build-property instead." in res.stderr
+    assert "-DMY_DEFINE=1" in res.stdout
+
+    sketch_path = copy_sketch("sketch_with_multiple_int_defines")
+    res = run_command(
+        f"compile -b {fqbn} "
+        + '--build-properties="build.extra_flags=-DFIRST_PIN=1,compiler.cpp.extra_flags=-DSECOND_PIN=2" '
+        + f"{sketch_path} --verbose --clean"
+    )
+    assert res.ok
+    assert "Flag --build-properties has been deprecated, please use --build-property instead." in res.stderr
+    assert "-DFIRST_PIN=1" in res.stdout
+    assert "-DSECOND_PIN=2" in res.stdout
+
+
+def test_compile_with_build_property_containing_quotes(run_command, data_dir, copy_sketch):
+    # Init the environment explicitly
+    assert run_command("core update-index")
+
+    # Install Arduino AVR Boards
+    assert run_command("core install arduino:[email protected]")
+
+    sketch_path = copy_sketch("sketch_with_single_string_define")
+    fqbn = "arduino:avr:uno"
+
+    # Compile using a build property with quotes
+    res = run_command(
+        f"compile -b {fqbn} "
+        + '--build-property="build.extra_flags=\\"-DMY_DEFINE=\\"hello world\\"\\"" '
         + f"{sketch_path} --verbose"
     )
     assert res.ok
     assert '-DMY_DEFINE=\\"hello world\\"' in res.stdout
 
 
-def test_compile_with_multiple_build_properties(run_command, data_dir, copy_sketch):
+def test_compile_with_multiple_build_property_flags(run_command, data_dir, copy_sketch, working_dir):
     # Init the environment explicitly
     assert run_command("core update-index")
 
@@ -265,42 +316,47 @@ def test_compile_with_multiple_build_properties(run_command, data_dir, copy_sket
     sketch_path = copy_sketch("sketch_with_multiple_defines")
     fqbn = "arduino:avr:uno"
 
-    # Create a test sketch
-    assert run_command(f"sketch new {sketch_path}")
-
     # Compile using multiple build properties separated by a space
     res = run_command(
         f"compile -b {fqbn} "
-        + '--build-properties="compiler.cpp.extra_flags=\\"-DPIN=2 -DSSID=\\"This is a String\\"\\"" '
-        + f"{sketch_path} --verbose"
+        + '--build-property=\'compiler.cpp.extra_flags=\\"-DPIN=2 -DSSID=\\"This is a String\\"\\"\' '
+        + f"{sketch_path} --verbose --clean"
+    )
+    assert res.failed
+
+    # Compile using multiple build properties separated by a space and properly quoted
+    res = run_command(
+        f"compile -b {fqbn} "
+        + '--build-property=\'compiler.cpp.extra_flags=-DPIN=2 "-DSSID="This is a String""\' '
+        + f"{sketch_path} --verbose --clean"
     )
     assert res.ok
-    assert '-DPIN=2 -DSSID=\\"This is a String\\"' in res.stdout
+    assert '-DPIN=2 "-DSSID=\\"This is a String\\""' in res.stdout
 
     # Tries compilation using multiple build properties separated by a comma
     res = run_command(
         f"compile -b {fqbn} "
-        + '--build-properties="compiler.cpp.extra_flags=\\"-DPIN=2,-DSSID=\\"This is a String\\"\\"\\" '
-        + f"{sketch_path} --verbose"
+        + '--build-property="compiler.cpp.extra_flags=\\"-DPIN=2,-DSSID=\\"This is a String\\"\\"\\" '
+        + f"{sketch_path} --verbose --clean"
     )
     assert res.failed
 
     res = run_command(
         f"compile -b {fqbn} "
-        + '--build-properties="compiler.cpp.extra_flags=\\"-DPIN=2\\"" '
-        + '--build-properties="compiler.cpp.extra_flags=\\"-DSSID=\\"This is a String\\"\\"" '
-        + f"{sketch_path} --verbose"
+        + '--build-property="compiler.cpp.extra_flags=\\"-DPIN=2\\"" '
+        + '--build-property="compiler.cpp.extra_flags=\\"-DSSID=\\"This is a String\\"\\"" '
+        + f"{sketch_path} --verbose --clean"
     )
-    assert res.ok
+    assert res.failed
     assert "-DPIN=2" not in res.stdout
     assert '-DSSID=\\"This is a String\\"' in res.stdout
 
     res = run_command(
         f"compile -b {fqbn} "
-        + '--build-properties="compiler.cpp.extra_flags=\\"-DPIN=2\\"" '
-        + '--build-properties="build.extra_flags=\\"-DMY_DEFINE=\\"hello world\\"\\"" '
-        + f"{sketch_path} --verbose"
+        + '--build-property="compiler.cpp.extra_flags=\\"-DPIN=2\\"" '
+        + '--build-property="build.extra_flags=\\"-DSSID=\\"hello world\\"\\"" '
+        + f"{sketch_path} --verbose --clean"
     )
     assert res.ok
     assert "-DPIN=2" in res.stdout
-    assert '-DMY_DEFINE=\\"hello world\\"' in res.stdout
+    assert '-DSSID=\\"hello world\\"' in res.stdout

Diff for: test/testdata/sketch_with_multiple_defines/sketch_with_multiple_defines.ino

@@ -3,6 +3,9 @@ const int DEFAULT_PIN = PIN;
 const String DEFAULT_SSID = SSID;
 
 void setup() {
+    Serial.begin(9600);
+    Serial.println(DEFAULT_PIN);
+    Serial.println(DEFAULT_SSID);
 }
 
 void loop() {

Diff for: test/testdata/sketch_with_multiple_int_defines/sketch_with_multiple_int_defines.ino

@@ -0,0 +1,12 @@
+
+const int MY_FIRST_PIN = FIRST_PIN;
+const int MY_SECOND_PIN = SECOND_PIN;
+
+void setup() {
+    Serial.begin(9600);
+    Serial.println(MY_FIRST_PIN);
+    Serial.println(MY_SECOND_PIN);
+}
+
+void loop() {
+}

Diff for: test/testdata/sketch_with_single_int_define/sketch_with_single_int_define.ino

@@ -0,0 +1,10 @@
+
+const int FOO = MY_DEFINE;
+
+void setup() {
+    Serial.begin(9600);
+    Serial.println(FOO);
+}
+
+void loop() {
+}

Diff for: test/testdata/sketch_with_single_define/sketch_with_single_define.ino renamed to test/testdata/sketch_with_single_string_define/sketch_with_single_string_define.ino

@@ -2,6 +2,8 @@
 const String FOO = MY_DEFINE;
 
 void setup() {
+    Serial.begin(9600);
+    Serial.println(FOO);
 }
 
 void loop() {