Uploaded image for project: 'Hadoop Common'
  1. Hadoop Common
  2. HADOOP-16962

Making `getBoolean` log warning message for unrecognized value

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.4.0
    • Component/s: conf
    • Labels:
      None

      Description

      Problem:

      In `Configuration.java`, the `getBoolean` can accept any valueString and return the default value for any string except “true” or “false” (ignoring case):

      if (StringUtils.equalsIgnoreCase("true", valueString))
        return true;
      else if (StringUtils.equalsIgnoreCase("false", valueString))
        return false;
      else return defaultValue;

      If the user misspells some boolean configuration value, for example, “true” to “ture”, then getBoolean will directly return the default value without logging any warning message. If the default value is “false”, then Hadoop is actually using a totally different value (“false”) compared to the user’s expectation (“true”) and the user even doesn’t know it.

      This can lead to serious issues, especially regarding security features.

      Other projects such as Alluxio are doing more rigorous and explicit check.
      https://github.com/xlab-uiuc/ctest-alluxio/blob/master/core/common/src/main/java/alluxio/conf/InstancedConfiguration.java#L366
      in which the getBoolean method will fail immediately if the value is invalid.

       

      Solution:

      We can log one warning message before getBoolean return the default value for unrecognized value:

      if (StringUtils.equalsIgnoreCase("true", valueString))
        return true;
      else if (StringUtils.equalsIgnoreCase("false", valueString))
        return false;
      else {
        LOG.warn("Invalid value for boolean: " + valueString +
                 ", choose default value: " + defaultValue + " for " + name);
        return defaultValue;
      }

      I attach a patch to log the warning message.

        Attachments

        1. HADOOP-16962.001.patch
          0.8 kB
          Ctest

          Activity

            People

            • Assignee:
              ctest.team Ctest
              Reporter:
              ctest.team Ctest
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: