✨ [commonerrors] Add Ignore so that errors can be ignored (#240)

<!--
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 IgnoreErrors so that errors can be ignored

### 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/20230428172043.feature

@@ -0,0 +1 @@
+:sparkles: `[commonerrors]` Add Ignore so that errors can be ignored

utils/commonerrors/errors.go

@@ -98,3 +98,11 @@ func ConvertContextError(err error) error {
 	}
 	return err
 }
+
+// Ignore will return nil if the target error matches one of the errors to ignore
+func Ignore(target error, ignore ...error) error {
+	if Any(target, ignore...) {
+		return nil
+	}
+	return target
+}

utils/commonerrors/errors_test.go

@@ -71,3 +71,14 @@ func TestContextErrorConversion(t *testing.T) {
 	require.NotNil(t, err)
 	assert.True(t, Any(err, ErrTimeout, ErrCancelled))
 }
+
+func TestIgnore(t *testing.T) {
+	assert.Equal(t, nil, Ignore(ErrNotImplemented, ErrInvalid, ErrNotImplemented, ErrUnknown))
+	assert.Equal(t, ErrNotImplemented, Ignore(ErrNotImplemented, ErrInvalid, ErrUnknown))
+	assert.Equal(t, nil, Ignore(ErrNotImplemented, nil, ErrNotImplemented))
+	assert.Equal(t, nil, Ignore(nil, nil, ErrNotImplemented))
+	assert.Equal(t, ErrNotImplemented, Ignore(ErrNotImplemented, nil, ErrInvalid, ErrUnknown))
+	assert.Equal(t, nil, Ignore(nil, ErrInvalid, ErrUnknown))
+	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))
+}