Add more context to errors (#216)

* Add more context to errors

* Unify project location format

* Fix test

Author: tothszabi

xcodeproject/xcodeproj/schemes.go

@@ -43,7 +43,7 @@ func (p XcodeProj) Schemes() ([]xcscheme.Scheme, error) {
 
 		isAutocreateSchemesEnabled, err := p.isAutocreateSchemesEnabled()
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("failed to read the project autocreate scheme option: %w", err)
 		}
 
 		if isAutocreateSchemesEnabled {

xcodeproject/xcworkspace/file_ref.go

@@ -38,7 +38,7 @@ func (f FileRef) TypeAndPath() (FileRefType, string, error) {
 	case "container":
 		return ContainerFileRefType, s[1], nil
 	default:
-		return "", "", fmt.Errorf("unknown file reference type: %s", s[0])
+		return "", "", fmt.Errorf("unknown file reference type: %s, value: %s", s[0], s[1])
 	}
 }
 

xcodeproject/xcworkspace/schemes.go

@@ -26,12 +26,12 @@ func (w Workspace) Schemes() (map[string][]xcscheme.Scheme, error) {
 
 	sharedSchemes, err := w.sharedSchemes()
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to read shared schemes: %w", err)
 	}
 
 	userSchemes, err := w.userSchemes()
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to read user schemes: %w", err)
 	}
 
 	workspaceSchemes := append(sharedSchemes, userSchemes...)
@@ -44,30 +44,30 @@ func (w Workspace) Schemes() (map[string][]xcscheme.Scheme, error) {
 	// project schemes
 	projectLocations, err := w.ProjectFileLocations()
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to get project locations from workspace: %w", err)
 	}
 
 	isAutocreateSchemesEnabled, err := w.isAutocreateSchemesEnabled()
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to read the workspace autocreate scheme option: %w", err)
 	}
 
 	for _, projectLocation := range projectLocations {
 		if exist, err := pathutil.IsPathExists(projectLocation); err != nil {
-			return nil, fmt.Errorf("failed to check if project exist at: %s, error: %s", projectLocation, err)
+			return nil, fmt.Errorf("failed to check if project (%s) exists: %w", projectLocation, err)
 		} else if !exist {
 			// at this point we are interested the schemes visible for the workspace
 			continue
 		}
 
 		project, err := xcodeproj.Open(projectLocation)
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("failed to open project (%s): %w", projectLocation, err)
 		}
 
 		projectSchemes, err := project.SchemesWithAutocreateEnabled(isAutocreateSchemesEnabled)
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("failed to read project (%s) schemes: %w", projectLocation, err)
 		}
 
 		if len(projectSchemes) > 0 {
@@ -179,7 +179,7 @@ func (w Workspace) isAutocreateSchemesEnabled() (bool, error) {
 
 	var settings serialized.Object
 	if _, err := plist.Unmarshal(workspaceSettingsContent, &settings); err != nil {
-		return false, err
+		return false, fmt.Errorf("failed to unmarshall settings: %w", err)
 	}
 
 	autoCreate, err := settings.Bool("IDEWorkspaceSharedSettings_AutocreateContextsIfNeeded")

xcodeproject/xcworkspace/schemes_test.go

@@ -1,6 +1,7 @@
 package xcworkspace
 
 import (
+	"fmt"
 	"path/filepath"
 	"testing"
 
@@ -66,7 +67,8 @@ func Test_GivenNewlyGeneratedWorkspaceWithAutocreateSchemesDisabled_WhenListingS
 	require.NoError(t, err)
 
 	schemesByContainer, err := workspace.Schemes()
-	require.EqualError(t, err, `no schemes found and the Xcode project's 'Autocreate schemes' option is disabled`)
+	expectedMessage := fmt.Sprintf(`failed to read project (%s) schemes: no schemes found and the Xcode project's 'Autocreate schemes' option is disabled`, xcodeProjectPath)
+	require.EqualError(t, err, expectedMessage)
 	require.Equal(t, 0, len(schemesByContainer))
 }