Introduce UnvalidatedEnumValueOfInvocation check

[ghokun]

Context

Enum.valueOf method usage may lead to runtime exceptions when the provided argument is not checked against all possible values of method owner.

Example:

class Test {
  enum A {
    ONE, TWO, THREE
  }
  
  enum B {
    ONE, TWO, THREE, FOUR
  }
  
  // Will throw a runtime exception if b is equal to FOUR.
  A convertUnsafe(B b) {
    return A.valueOf(b.name());
  }
}

Scope

Of course it is not able to capture all possible checks on b before supplying it into A.valueOf. Therefore scope will be limited to following checks.

// BUG: Raw string
A convertUnsafe(String raw) {
  return A.valueOf(raw);
}

// BUG: From invalid string constant
A convertUnsafe() {
  return A.valueOf("FOUR");
}

// BUG: Where B has values that A do not have
A convertUnsafe(B b) {
  return A.valueOf(b.name());
}

// BUG: Value from case is not present in A
A convertUnsafe(B b) {
  return switch(b) { case FOUR -> A.valueOf(b.name()); };
}

// NOT BUG: Value from case is present in A
A convertUnsafe(B b) {
  return switch(b) { case ONE -> A.valueOf(b.name()); };
}

// NOT BUG: From valid string constant
A convertSafe() {
  return A.valueOf("ONE");
}

Above checks should also consider the polymorphic variant of valueOf:

public static <T extends Enum<T>> T valueOf(Class<T> enumClass, String name)

[github-actions]

Suggested commit message:

Introduce `UnvalidatedEnumValueOfInvocation` check (#2031)

[github-actions]

• Surviving mutants in this change: 3
• Killed mutants in this change: 7

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.EnumValueOfSuperSet	3	7

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[github-actions]

• Surviving mutants in this change: 2
• Killed mutants in this change: 7

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.EnumValueOfSuperSet	2	7

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[github-actions]

• Surviving mutants in this change: 2
• Killed mutants in this change: 7

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.EnumValueOfSuperSet	2	7

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[github-actions]

• Surviving mutants in this change: 12
• Killed mutants in this change: 16

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.EnumValueOfUsage	12	16

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[github-actions]

• Surviving mutants in this change: 6
• Killed mutants in this change: 24

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.EnumValueOfUsage	6	24

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[github-actions]

• Surviving mutants in this change: 12
• Killed mutants in this change: 33

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.EnumValueOfUsage	12	33

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[github-actions]

• Surviving mutants in this change: 12
• Killed mutants in this change: 33

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.EnumValueOfUsage	12	33

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[ghokun]

I will try to resolve mutation test reports when I have the time.

[github-actions]

• Surviving mutants in this change: 3
• Killed mutants in this change: 40

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.UnvalidatedEnumValueOfInvocation	3	40

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[ghokun]

There are also potential cases which I ignored on purpose such as:

enum A {ONE};
enum B {ONE, TWO};
record D(B b) {}

D d = new D(B.ONE);
switch (d) {
  case D(B deconstructedB) when B == ONE -> ..
  case D(B deconstructedB) when B == TWO -> ..
};

I think this will complicate things even further. Should we place it inside the ignored part?

[github-actions]

• Surviving mutants in this change: 8
• Killed mutants in this change: 50

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.UnvalidatedEnumValueOfInvocation	8	50

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[ghokun]

Placed here to be explicit about the ignored case, if you see an easy way to implement it or that it is possible, let me know.

[github-actions]

• Surviving mutants in this change: 8
• Killed mutants in this change: 50

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.UnvalidatedEnumValueOfInvocation	8	50

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[ghokun]

• Switch Cases are valid
• Types match
• Symbols do not match
• Value from the provided enum is a MemberSelectTree which is not present in A.class

[github-actions]

• Surviving mutants in this change: 8
• Killed mutants in this change: 52

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.UnvalidatedEnumValueOfInvocation	8	52

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
95.4% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

• Surviving mutants in this change: 8
• Killed mutants in this change: 52

class	surviving	killed
🧟tech.picnic.errorprone.bugpatterns.UnvalidatedEnumValueOfInvocation	8	52

Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

• Arcmutate licence valid until 2027-10-20 (yyyy/mm/dd) (non-commercial use only)
• Project uses Spring, but the Arcmutate Spring plugin is not present.
• TestNG is on the classpath but the pitest TestNG plugin is not installed.