updated tests and fixed some error wording

cmaglie · cmaglie · commit 763fcb82a4fd · 2021-08-28T20:19:14.000+02:00
diff --git a/commands/board/attach.go b/commands/board/attach.go
@@ -46,7 +46,7 @@ func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.Ta
 	}
 	sk, err := sketch.New(sketchPath)
 	if err != nil {
-		return nil, &commands.SketchNotFoundError{Cause: err}
+		return nil, &commands.CantOpenSketchError{Cause: err}
 	}
 
 	boardURI := req.GetBoardUri()
diff --git a/commands/compile/compile.go b/commands/compile/compile.go
@@ -99,7 +99,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	sketchPath := paths.New(req.GetSketchPath())
 	sk, err := sketch.New(sketchPath)
 	if err != nil {
-		return nil, &commands.SketchNotFoundError{Cause: err}
+		return nil, &commands.CantOpenSketchError{Cause: err}
 	}
 
 	fqbnIn := req.GetFqbn()
diff --git a/commands/debug/debug_info.go b/commands/debug/debug_info.go
@@ -44,7 +44,7 @@ func getDebugProperties(req *debug.DebugConfigRequest, pm *packagemanager.Packag
 	sketchPath := paths.New(req.GetSketchPath())
 	sk, err := sketch.New(sketchPath)
 	if err != nil {
-		return nil, &commands.SketchNotFoundError{Cause: err}
+		return nil, &commands.CantOpenSketchError{Cause: err}
 	}
 
 	// XXX Remove this code duplication!!
diff --git a/commands/errors.go b/commands/errors.go
@@ -304,20 +304,20 @@ func (e *MissingSketchPathError) ToRPCStatus() *status.Status {
 	return status.New(codes.InvalidArgument, e.Error())
 }
 
-// SketchNotFoundError is returned when the sketch is not found
-type SketchNotFoundError struct {
+// CantOpenSketchError is returned when the sketch is not found or cannot be opened
+type CantOpenSketchError struct {
 	Cause error
 }
 
-func (e *SketchNotFoundError) Error() string {
-	return composeErrorMsg(tr("Sketch not found"), e.Cause)
+func (e *CantOpenSketchError) Error() string {
+	return composeErrorMsg(tr("Can't open sketch"), e.Cause)
 }
 
-func (e *SketchNotFoundError) Unwrap() error {
+func (e *CantOpenSketchError) Unwrap() error {
 	return e.Cause
 }
 
-func (e *SketchNotFoundError) ToRPCStatus() *status.Status {
+func (e *CantOpenSketchError) ToRPCStatus() *status.Status {
 	return status.New(codes.NotFound, e.Error())
 }
 
diff --git a/commands/instances.go b/commands/instances.go
@@ -862,7 +862,7 @@ func LoadSketch(ctx context.Context, req *rpc.LoadSketchRequest) (*rpc.LoadSketc
 	// TODO: This should be a ToRpc function for the Sketch struct
 	sketch, err := sk.New(paths.New(req.SketchPath))
 	if err != nil {
-		return nil, &SketchNotFoundError{Cause: err}
+		return nil, &CantOpenSketchError{Cause: err}
 	}
 
 	otherSketchFiles := make([]string, sketch.OtherSketchFiles.Len())
diff --git a/commands/sketch/archive.go b/commands/sketch/archive.go
@@ -43,7 +43,7 @@ func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchRequest) (*rpc.Arc
 
 	s, err := sketch.New(sketchPath)
 	if err != nil {
-		return nil, &commands.SketchNotFoundError{Cause: err}
+		return nil, &commands.CantOpenSketchError{Cause: err}
 	}
 
 	sketchPath = s.FullPath
diff --git a/commands/upload/upload.go b/commands/upload/upload.go
@@ -123,7 +123,7 @@ func Upload(ctx context.Context, req *rpc.UploadRequest, outStream io.Writer, er
 	sketchPath := paths.New(req.GetSketchPath())
 	sk, err := sketch.New(sketchPath)
 	if err != nil && req.GetImportDir() == "" && req.GetImportFile() == "" {
-		return nil, &commands.SketchNotFoundError{Cause: err}
+		return nil, &commands.CantOpenSketchError{Cause: err}
 	}
 
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
diff --git a/test/test_board.py b/test/test_board.py
@@ -528,7 +528,7 @@ def test_board_details_no_flags(run_command):
     run_command("core install arduino:samd@1.8.6")
     result = run_command("board details")
     assert not result.ok
-    assert "Error getting board details: parsing fqbn: invalid fqbn:" in result.stderr
+    assert "Error getting board details: Invalid FQBN:" in result.stderr
     assert result.stdout == ""
 
 
diff --git a/test/test_compile.py b/test/test_compile.py
@@ -132,7 +132,7 @@ def test_compile_with_sketch_with_symlink_selfloop(run_command, data_dir):
     result = run_command("compile -b {fqbn} {sketch_path}".format(fqbn=fqbn, sketch_path=sketch_path))
     # The assertion is a bit relaxed in this case because win behaves differently from macOs and linux
     # returning a different error detailed message
-    assert "Error during build: opening sketch" in result.stderr
+    assert "Error during build: Can't open sketch:" in result.stderr
     assert not result.ok
 
     sketch_name = "CompileIntegrationTestSymlinkDirLoop"
@@ -154,7 +154,7 @@ def test_compile_with_sketch_with_symlink_selfloop(run_command, data_dir):
     result = run_command("compile -b {fqbn} {sketch_path}".format(fqbn=fqbn, sketch_path=sketch_path))
     # The assertion is a bit relaxed in this case because win behaves differently from macOs and linux
     # returning a different error detailed message
-    assert "Error during build: opening sketch" in result.stderr
+    assert "Error during build: Can't open sketch:" in result.stderr
     assert not result.ok
 
 
@@ -685,17 +685,17 @@ def test_compile_sketch_with_multiple_main_files(run_command, data_dir):
     # Build sketch from folder
     res = run_command(f"compile --clean -b {fqbn} {sketch_path}")
     assert res.failed
-    assert "Error during build: opening sketch: multiple main sketch files found" in res.stderr
+    assert "Error during build: Can't open sketch: multiple main sketch files found" in res.stderr
 
     # Build sketch from .ino file
     res = run_command(f"compile --clean -b {fqbn} {sketch_ino_file}")
     assert res.failed
-    assert "Error during build: opening sketch: multiple main sketch files found" in res.stderr
+    assert "Error during build: Can't open sketch: multiple main sketch files found" in res.stderr
 
     # Build sketch from .pde file
     res = run_command(f"compile --clean -b {fqbn} {sketch_pde_file}")
     assert res.failed
-    assert "Error during build: opening sketch: multiple main sketch files found" in res.stderr
+    assert "Error during build: Can't open sketch: multiple main sketch files found" in res.stderr
 
 
 def test_compile_sketch_case_mismatch_fails(run_command, data_dir):
@@ -718,15 +718,15 @@ def test_compile_sketch_case_mismatch_fails(run_command, data_dir):
     # * Compiling with sketch path
     res = run_command(f"compile --clean -b {fqbn} {sketch_path}")
     assert res.failed
-    assert "Error during build: opening sketch: no valid sketch found" in res.stderr
+    assert "Error during build: Can't open sketch: no valid sketch found" in res.stderr
     # * Compiling with sketch main file
     res = run_command(f"compile --clean -b {fqbn} {sketch_main_file}")
     assert res.failed
-    assert "Error during build: opening sketch: no valid sketch found" in res.stderr
+    assert "Error during build: Can't open sketch: no valid sketch found" in res.stderr
     # * Compiling in sketch path
     res = run_command(f"compile --clean -b {fqbn}", custom_working_dir=sketch_path)
     assert res.failed
-    assert "Error during build: opening sketch: no valid sketch found" in res.stderr
+    assert "Error during build: Can't open sketch: no valid sketch found" in res.stderr
 
 
 def test_compile_with_only_compilation_database_flag(run_command, data_dir):
diff --git a/test/test_core.py b/test/test_core.py
@@ -177,7 +177,7 @@ def test_core_updateindex_url_not_found(run_command, httpserver):
     result = run_command(f"core update-index --additional-urls={url}")
     assert result.failed
     lines = [l.strip() for l in result.stderr.splitlines()]
-    assert f"Error updating index: downloading index {url}: 404 NOT FOUND" in lines
+    assert f"Error updating index: Error downloading index '{url}': Server responded with: 404 NOT FOUND" in lines
 
 
 def test_core_updateindex_internal_server_error(run_command, httpserver):
@@ -190,7 +190,10 @@ def test_core_updateindex_internal_server_error(run_command, httpserver):
     result = run_command(f"core update-index --additional-urls={url}")
     assert result.failed
     lines = [l.strip() for l in result.stderr.splitlines()]
-    assert f"Error updating index: downloading index {url}: 500 INTERNAL SERVER ERROR" in lines
+    assert (
+        f"Error updating index: Error downloading index '{url}': Server responded with: 500 INTERNAL SERVER ERROR"
+        in lines
+    )
 
 
 def test_core_install_without_updateindex(run_command):
diff --git a/test/test_lib.py b/test/test_lib.py
@@ -117,18 +117,14 @@ def test_list_exit_code(run_command):
     # Verify lib list command fails because specified platform is not installed
     result = run_command("lib list -b arduino:samd:mkr1000")
     assert result.failed
-    assert (
-        result.stderr.strip() == "Error listing Libraries: loading board data: platform arduino:samd is not installed"
-    )
+    assert result.stderr.strip() == "Error listing Libraries: Unknown FQBN: platform arduino:samd is not installed"
 
     assert run_command('lib install "AllThingsTalk LoRaWAN SDK"')
 
     # Verifies lib list command keeps failing
     result = run_command("lib list -b arduino:samd:mkr1000")
     assert result.failed
-    assert (
-        result.stderr.strip() == "Error listing Libraries: loading board data: platform arduino:samd is not installed"
-    )
+    assert result.stderr.strip() == "Error listing Libraries: Unknown FQBN: platform arduino:samd is not installed"
 
     assert run_command("core install arduino:samd")
 
@@ -224,7 +220,7 @@ def test_install(run_command):
     # (https://github.com/arduino/arduino-cli/issues/534)
     res = run_command("lib install MD_Parola@3.2.0")
     assert res.failed
-    assert "Error resolving dependencies for MD_Parola@3.2.0: dependency 'MD_MAX72xx' is not available" in res.stderr
+    assert "No valid dependencies solution found: dependency 'MD_MAX72xx' is not available" in res.stderr
 
 
 def test_install_library_with_dependencies(run_command):
diff --git a/test/test_sketch.py b/test/test_sketch.py
@@ -845,7 +845,7 @@ def test_sketch_archive_with_multiple_main_files(run_command, copy_sketch, worki
     assert res.failed
     assert "Sketches with .pde extension are deprecated, please rename the following files to .ino" in res.stderr
     assert str(sketch_file.relative_to(sketch_dir)) in res.stderr
-    assert "Error archiving: multiple main sketch files found" in res.stderr
+    assert "Error archiving: Can't open sketch: multiple main sketch files found" in res.stderr
 
 
 def test_sketch_archive_case_mismatch_fails(run_command, data_dir):
@@ -859,4 +859,4 @@ def test_sketch_archive_case_mismatch_fails(run_command, data_dir):
 
     res = run_command(f'sketch archive "{sketch_path}"')
     assert res.failed
-    assert "Error archiving: no valid sketch found" in res.stderr
+    assert "Error archiving: Can't open sketch: no valid sketch found" in res.stderr
diff --git a/test/test_update.py b/test/test_update.py
@@ -63,7 +63,10 @@ def test_update_with_url_not_found(run_command, httpserver):
     res = run_command(f"update --additional-urls={url}")
     assert res.failed
     lines = [l.strip() for l in res.stderr.splitlines()]
-    assert f"Error updating core and libraries index: downloading index {url}: 404 NOT FOUND" in lines
+    assert (
+        f"Error updating core and libraries index: Error downloading index '{url}':"
+        " Server responded with: 404 NOT FOUND" in lines
+    )
 
 
 def test_update_with_url_internal_server_error(run_command, httpserver):
@@ -76,7 +79,10 @@ def test_update_with_url_internal_server_error(run_command, httpserver):
     res = run_command(f"update --additional-urls={url}")
     assert res.failed
     lines = [l.strip() for l in res.stderr.splitlines()]
-    assert f"Error updating core and libraries index: downloading index {url}: 500 INTERNAL SERVER ERROR" in lines
+    assert (
+        f"Error updating core and libraries index: Error downloading index '{url}':"
+        " Server responded with: 500 INTERNAL SERVER ERROR" in lines
+    )
 
 
 def test_update_showing_outdated_using_library_with_invalid_version(run_command, data_dir):

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.Ta`
`46`	`46`	`}`
`47`	`47`	`sk, err := sketch.New(sketchPath)`
`48`	`48`	`if err != nil {`
`49`		`- return nil, &commands.SketchNotFoundError{Cause: err}`
	`49`	`+ return nil, &commands.CantOpenSketchError{Cause: err}`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`boardURI := req.GetBoardUri()`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream`
`99`	`99`	`sketchPath := paths.New(req.GetSketchPath())`
`100`	`100`	`sk, err := sketch.New(sketchPath)`
`101`	`101`	`if err != nil {`
`102`		`- return nil, &commands.SketchNotFoundError{Cause: err}`
	`102`	`+ return nil, &commands.CantOpenSketchError{Cause: err}`
`103`	`103`	`}`
`104`	`104`
`105`	`105`	`fqbnIn := req.GetFqbn()`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ func getDebugProperties(req debug.DebugConfigRequest, pm packagemanager.Packag`
`44`	`44`	`sketchPath := paths.New(req.GetSketchPath())`
`45`	`45`	`sk, err := sketch.New(sketchPath)`
`46`	`46`	`if err != nil {`
`47`		`- return nil, &commands.SketchNotFoundError{Cause: err}`
	`47`	`+ return nil, &commands.CantOpenSketchError{Cause: err}`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`// XXX Remove this code duplication!!`
Original file line number	Diff line number	Diff line change
`@@ -304,20 +304,20 @@ func (e MissingSketchPathError) ToRPCStatus() status.Status {`
`304`	`304`	`return status.New(codes.InvalidArgument, e.Error())`
`305`	`305`	`}`
`306`	`306`
`307`		`-// SketchNotFoundError is returned when the sketch is not found`
`308`		`-type SketchNotFoundError struct {`
	`307`	`+// CantOpenSketchError is returned when the sketch is not found or cannot be opened`
	`308`	`+type CantOpenSketchError struct {`
`309`	`309`	`Cause error`
`310`	`310`	`}`
`311`	`311`
`312`		`-func (e *SketchNotFoundError) Error() string {`
`313`		`- return composeErrorMsg(tr("Sketch not found"), e.Cause)`
	`312`	`+func (e *CantOpenSketchError) Error() string {`
	`313`	`+ return composeErrorMsg(tr("Can't open sketch"), e.Cause)`
`314`	`314`	`}`
`315`	`315`
`316`		`-func (e *SketchNotFoundError) Unwrap() error {`
	`316`	`+func (e *CantOpenSketchError) Unwrap() error {`
`317`	`317`	`return e.Cause`
`318`	`318`	`}`
`319`	`319`
`320`		`-func (e SketchNotFoundError) ToRPCStatus() status.Status {`
	`320`	`+func (e CantOpenSketchError) ToRPCStatus() status.Status {`
`321`	`321`	`return status.New(codes.NotFound, e.Error())`
`322`	`322`	`}`
`323`	`323`
Original file line number	Diff line number	Diff line change
`@@ -862,7 +862,7 @@ func LoadSketch(ctx context.Context, req rpc.LoadSketchRequest) (rpc.LoadSketc`
`862`	`862`	`// TODO: This should be a ToRpc function for the Sketch struct`
`863`	`863`	`sketch, err := sk.New(paths.New(req.SketchPath))`
`864`	`864`	`if err != nil {`
`865`		`- return nil, &SketchNotFoundError{Cause: err}`
	`865`	`+ return nil, &CantOpenSketchError{Cause: err}`
`866`	`866`	`}`
`867`	`867`
`868`	`868`	`otherSketchFiles := make([]string, sketch.OtherSketchFiles.Len())`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ func ArchiveSketch(ctx context.Context, req rpc.ArchiveSketchRequest) (rpc.Arc`
`43`	`43`
`44`	`44`	`s, err := sketch.New(sketchPath)`
`45`	`45`	`if err != nil {`
`46`		`- return nil, &commands.SketchNotFoundError{Cause: err}`
	`46`	`+ return nil, &commands.CantOpenSketchError{Cause: err}`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`sketchPath = s.FullPath`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ func Upload(ctx context.Context, req *rpc.UploadRequest, outStream io.Writer, er`
`123`	`123`	`sketchPath := paths.New(req.GetSketchPath())`
`124`	`124`	`sk, err := sketch.New(sketchPath)`
`125`	`125`	`if err != nil && req.GetImportDir() == "" && req.GetImportFile() == "" {`
`126`		`- return nil, &commands.SketchNotFoundError{Cause: err}`
	`126`	`+ return nil, &commands.CantOpenSketchError{Cause: err}`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`pm := commands.GetPackageManager(req.GetInstance().GetId())`