tgravescs commented on a change in pull request #34120:
URL: https://github.com/apache/spark/pull/34120#discussion_r718570904
##########
File path:
resource-managers/yarn/src/main/scala/org/apache/spark/deploy/yarn/Client.scala
##########
@@ -1470,6 +1471,84 @@ private object Client extends Logging {
(mainUri ++ secondaryUris).toArray
}
+ /**
+ * Returns a list of local, absolute file URLs representing the user
classpath. Note that this
+ * must be executed on the same host which will access the URLs, as it will
resolve relative
+ * paths based on the current working directory, as well as environment
variables.
+ *
+ * @param conf Spark configuration.
+ * @param useClusterPath Whether to use the 'cluster' path when resolving
paths with the
+ * `local` scheme. This should be used when running on
the cluster, but
+ * not when running on the gateway (i.e. for the
driver in `client` mode).
+ * @return Array of local URLs ready to be passed to a
[[java.net.URLClassLoader]].
+ */
+ def getUserClasspathUrls(conf: SparkConf, useClusterPath: Boolean):
Array[URL] = {
+ Client.getUserClasspath(conf).map { uri =>
+ val inputPath = uri.getPath
+ val replacedFilePath = if (Utils.isLocalUri(uri.toString) &&
useClusterPath) {
+ Client.getClusterPath(conf, inputPath)
+ } else {
+ // Any other URI schemes should have been resolved by this point
+ assert(uri.getScheme == null || uri.getScheme == "file" ||
Utils.isLocalUri(uri.toString),
+ "getUserClasspath should only return 'file' or 'local' URIs but
found: " + uri)
+ inputPath
+ }
+ val envVarResolvedFilePath = replaceEnvVars(replacedFilePath, sys.env)
+ Paths.get(envVarResolvedFilePath).toAbsolutePath.toUri.toURL
+ }
+ }
+
+ /**
+ * Replace environment variables in a string according to the same rules
[[Environment]]:
+ * `$VAR_NAME` for Unix, `%VAR_NAME%` for Windows, and `{{VAR_NAME}}` for
all OS.
+ * This support escapes for `$` and `%` characters, e.g.
+ * `\$FOO` and `%%FOO%%` will be resolved to `$FOO` and `%FOO%`,
respectively, instead of being
+ * treated as variable names.
+ *
+ * @param unresolvedString The unresolved string which may contain variable
references.
+ * @param env The System environment
+ * @param isWindows True iff running in a Windows environment
+ * @return The input string with variables replaced with their values from
`env`
+ */
+ def replaceEnvVars(
+ unresolvedString: String,
+ env: IMap[String, String],
+ isWindows: Boolean = Shell.WINDOWS): String = {
+ val osResolvedString = if (isWindows) {
+ // Environment variable names can contain anything besides = and %
+ // Ref:
https://docs.microsoft.com/en-us/windows/win32/procthread/environment-variables
+ val windowsPattern = "(?:%%|%([^=%]+)%)".r
+ windowsPattern.replaceAllIn(unresolvedString, m =>
+ Regex.quoteReplacement(m.matched match {
+ case "%%" => "%"
+ case _ => env.getOrElse(m.group(1), "")
+ })
+ )
+ } else {
+ // Environment variables are alphanumeric plus underscore,
case-sensitive, can't start with
+ // a digit, based on Shell and Utilities volume of IEEE Std 1003.1-2001
+ // Ref:
https://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html
+ val unixPattern =
"""(?i)(?:\\\\|\\\$|\$([A-Z_][A-Z0-9_]*))|\$\{([A-Z_][A-Z0-9_]*)}""".r
+ unixPattern.replaceAllIn(unresolvedString, m =>
+ Regex.quoteReplacement(m.matched match {
+ case """\\""" => """\"""
+ case """\$""" => """$"""
+ case _ => m.subgroups.filterNot(_ == null).headOption match {
+ case Some(v) => env.getOrElse(v, "")
+ case None =>
+ // Note that this should never be reached and indicates a bug
+ throw new IllegalStateException(s"No valid capture group was
found for match: $m")
+ }
+ })
+ )
+ }
+
+ // {{...}} is a YARN thing and not OS-specific. Follow Unix shell naming
conventions
+ val yarnPattern = "(?i)\\{\\{([A-Z_][A-Z0-9_]*)}}".r
+ yarnPattern.replaceAllIn(osResolvedString,
+ m => Regex.quoteReplacement(env.getOrElse(m.group(1), "")))
Review comment:
I'd like more details in the comment here. This I assume used to go into
the launch script in NM and then yarn would replace {{VAR}} with whatever it
was actually. Have comment about how that used to work would be better so
people don't wonder how yarn comes into play
##########
File path:
resource-managers/yarn/src/main/scala/org/apache/spark/deploy/yarn/Client.scala
##########
@@ -1470,6 +1471,84 @@ private object Client extends Logging {
(mainUri ++ secondaryUris).toArray
}
+ /**
+ * Returns a list of local, absolute file URLs representing the user
classpath. Note that this
+ * must be executed on the same host which will access the URLs, as it will
resolve relative
+ * paths based on the current working directory, as well as environment
variables.
+ *
+ * @param conf Spark configuration.
+ * @param useClusterPath Whether to use the 'cluster' path when resolving
paths with the
+ * `local` scheme. This should be used when running on
the cluster, but
+ * not when running on the gateway (i.e. for the
driver in `client` mode).
+ * @return Array of local URLs ready to be passed to a
[[java.net.URLClassLoader]].
+ */
+ def getUserClasspathUrls(conf: SparkConf, useClusterPath: Boolean):
Array[URL] = {
+ Client.getUserClasspath(conf).map { uri =>
+ val inputPath = uri.getPath
+ val replacedFilePath = if (Utils.isLocalUri(uri.toString) &&
useClusterPath) {
+ Client.getClusterPath(conf, inputPath)
+ } else {
+ // Any other URI schemes should have been resolved by this point
+ assert(uri.getScheme == null || uri.getScheme == "file" ||
Utils.isLocalUri(uri.toString),
+ "getUserClasspath should only return 'file' or 'local' URIs but
found: " + uri)
+ inputPath
+ }
+ val envVarResolvedFilePath = replaceEnvVars(replacedFilePath, sys.env)
+ Paths.get(envVarResolvedFilePath).toAbsolutePath.toUri.toURL
+ }
+ }
+
+ /**
+ * Replace environment variables in a string according to the same rules
[[Environment]]:
+ * `$VAR_NAME` for Unix, `%VAR_NAME%` for Windows, and `{{VAR_NAME}}` for
all OS.
+ * This support escapes for `$` and `%` characters, e.g.
+ * `\$FOO` and `%%FOO%%` will be resolved to `$FOO` and `%FOO%`,
respectively, instead of being
+ * treated as variable names.
+ *
+ * @param unresolvedString The unresolved string which may contain variable
references.
+ * @param env The System environment
+ * @param isWindows True iff running in a Windows environment
+ * @return The input string with variables replaced with their values from
`env`
+ */
+ def replaceEnvVars(
Review comment:
this is very unfortunate, for us to have to emulate this. I was looking
for other libraries that perhaps do this that we could just use, I saw
https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringSubstitutor.html
but I think its a basic string replace.
If this was passed in an environment variable does everything get replaced
properly? I thought yarn would put it in the launch script and then properly
handle replacements.
env variables have much longer length and normally you would set the class
path environment variable if doing it the more traditional way so assume it
would fit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
