✨ commonerrors Add support for determining commonerror from a string (#468)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->
### Description

<!--
Please add any detail or context that would be useful to a reviewer.
-->

Add support for determining commonerror from a string

### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [x]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

Author: joshjennings98

changes/20240604150742.feature

@@ -0,0 +1 @@
+:sparkles: `commonerrors` Add support for determining commonerror from a string

utils/commonerrors/errors.go

@@ -101,6 +101,17 @@ func CorrespondTo(target error, description ...string) bool {
 	return false
 }
 
+// RelatesTo determines whether an error description string could relate to a particular set of common errors
+// This assumes that the error description follows the convention of placing the type of errors at the start of the string.
+func RelatesTo(target string, errors ...error) bool {
+	for i := range errors {
+		if strings.HasPrefix(target, errors[i].Error()) {
+			return true
+		}
+	}
+	return false
+}
+
 // deserialiseCommonError returns the common error corresponding to its string value
 func deserialiseCommonError(errStr string) (bool, error) {
 	errStr = strings.TrimSpace(errStr)

utils/commonerrors/errors_test.go

@@ -186,3 +186,18 @@ func TestIgnore(t *testing.T) {
 	assert.Equal(t, nil, Ignore(fmt.Errorf("an error %w", ErrNotImplemented), ErrInvalid, ErrNotImplemented, ErrUnknown))
 	assert.Equal(t, fmt.Errorf("an error %w", ErrNotImplemented), Ignore(fmt.Errorf("an error %w", ErrNotImplemented), ErrInvalid, ErrUnknown))
 }
+
+func TestErrorRelatesTo(t *testing.T) {
+	assert.True(t, RelatesTo(fmt.Errorf("%w: %v", ErrInvalid, faker.Sentence()).Error(), ErrInvalid))
+	assert.True(t, RelatesTo(fmt.Errorf("%w: %v", ErrInvalid, faker.Sentence()).Error(), ErrInvalid, ErrCondition))
+	assert.False(t, RelatesTo(fmt.Errorf("%w: %v", ErrUnauthorised, faker.Sentence()).Error(), ErrInvalid))
+	assert.False(t, RelatesTo(fmt.Errorf("%w: %v", ErrUnauthorised, faker.Sentence()).Error(), ErrInvalid, ErrCondition))
+	assert.True(t, RelatesTo(fmt.Sprint(fmt.Errorf("%w: %v", ErrInvalid, faker.Sentence())), ErrInvalid))
+	assert.True(t, RelatesTo(fmt.Sprint(fmt.Errorf("%w: %v", ErrInvalid, faker.Sentence())), ErrInvalid, ErrCondition))
+	assert.False(t, RelatesTo(fmt.Sprint(fmt.Errorf("%w: %v", ErrUnauthorised, faker.Sentence())), ErrInvalid))
+	assert.False(t, RelatesTo(fmt.Sprint(fmt.Errorf("%w: %v", ErrUnauthorised, faker.Sentence())), ErrInvalid, ErrCondition))
+	assert.True(t, RelatesTo(fmt.Sprintf("%v: %v", ErrInvalid.Error(), faker.Sentence()), ErrInvalid))
+	assert.True(t, RelatesTo(fmt.Sprintf("%v: %v", ErrInvalid.Error(), faker.Sentence()), ErrInvalid, ErrCondition))
+	assert.False(t, RelatesTo(fmt.Sprintf("%v: %v", ErrUnauthorised.Error(), faker.Sentence()), ErrInvalid))
+	assert.False(t, RelatesTo(fmt.Sprintf("%v: %v", ErrUnauthorised.Error(), faker.Sentence()), ErrInvalid, ErrCondition))
+}