[CLI-347] Options.addOptionGroup(OptionGroup) does not remove required

options from requiredOpts list

Author: garydgregory

src/changes/changes.xml

@@ -37,6 +37,7 @@
       <action type="fix" issue="CLI-341" dev="ggregory" due-to="Ruiqi Dong, Gary Gregory">HelpFormatter infinite loop with 0 width input.</action>
       <action type="fix" issue="CLI-349" dev="ggregory" due-to="Leo Fernandes, Gary Gregory">Fail faster with a more precise NullPointerException: Option.processValue() throws NullPointerException when passed null value with value separator configured.</action>
       <action type="fix" issue="CLI-344" dev="ggregory" due-to="Ruiqi Dong, Gary Gregory">Fail faster with a more precise NullPointerException: DefaultParser.parse() throws NullPointerException when options parameter is null.</action>
+      <action type="fix" issue="CLI-347" dev="ggregory" due-to="Ruiqi Dong, Gary Gregory">Options.addOptionGroup(OptionGroup) does not remove required options from requiredOpts list.</action>
       <!-- ADD -->
       <action type="add" issue="CLI-339" dev="ggregory" due-to="Claude Warren, Gary Gregory">Help formatter extension in the new package #314.</action>
       <action type="add" dev="ggregory" due-to="Gary Gregory">CommandLine.Builder implements Supplier&lt;CommandLine&gt;.</action>

src/main/java/org/apache/commons/cli/Options.java

@@ -155,8 +155,10 @@ public Options addOptionGroup(final OptionGroup group) {
             // OptionGroup, either the group is required or
             // nothing is required
             option.setRequired(false);
+            final String key = option.getKey();
+            requiredOpts.remove(key);
             addOption(option);
-            optionGroups.put(option.getKey(), group);
+            optionGroups.put(key, group);
         }
         return this;
     }

src/test/java/org/apache/commons/cli/OptionsTest.java

@@ -36,6 +36,21 @@ Licensed to the Apache Software Foundation (ASF) under one or more
 @SuppressWarnings("deprecation") // tests some deprecated classes
 class OptionsTest {
 
+    @Test
+    void testRequiredOptionInGroupShouldNotBeInRequiredList() {
+        final String key = "a";
+        final Option option = new Option(key, "along", false, "Option A");
+        option.setRequired(true);
+        final Options options = new Options();
+        options.addOption(option);
+        assertTrue(options.getRequiredOptions().contains(key));
+        final OptionGroup optionGroup = new OptionGroup();
+        optionGroup.addOption(option);
+        options.addOptionGroup(optionGroup);
+        assertFalse(options.getOption(key).isRequired());
+        assertFalse(options.getRequiredOptions().contains(key), "Option in group shouldn't be in required options list.");
+    }
+
     private void assertToStrings(final Option option) {
         // Should never throw.
         // Should return a String, not null.