constants

Documentation

Overview

Package constants defines relevant constants common to multiple extractors.

Index

• Variables

Variables

var (
	// KytheBuildPreprocessorImage is defiend in
	// kythe/go/extractors/config/preprocessor, and is published to GCR.
	KytheBuildPreprocessorImage = "gcr.io/kythe-public/build-preprocessor:stable"

	// DefaultExtractorsDir is the canonical directory for extractors that any
	// kythe docker image will use.  This can be useful if you need to load that
	// volume to get access to kythe extractors.
	DefaultExtractorsDir = "/opt/kythe/extractors"

	// KytheJavacExtractorArtifactsImage is defined in
	// kythe/java/com/google/devtools/kythe/extractors/java/artifacts, and
	// published to GCR.
	KytheJavacExtractorArtifactsImage = "gcr.io/kythe-public/kythe-javac-extractor-artifacts:stable"

	// DefaultJavacWrapperLocation is the location of the Kythe wrapper around
	// javac that does extraction.
	DefaultJavacWrapperLocation = "/opt/kythe/extractors/javac-wrapper.sh"
	// DefaultJavaExtractorLocation is the location of the actual extractor.
	DefaultJavaExtractorLocation = "/opt/kythe/extractors/javac_extractor.jar"
	// DefaultJava9ToolsLocation is the location of a jar which allows java9
	// compatibility for java8.
	DefaultJava9ToolsLocation = "/opt/kythe/extractors/javac9_tools.jar"

	// KytheKzipToolsImage is defined in
	// kythe/go/platform/tools/kzip and published to GCR via
	// kythe/go/extractors/gcp/config/kziptool:artifacts.  It is a utility for
	// manipulating .kzip files.
	KytheKzipToolsImage = "gcr.io/kythe-public/kzip-tools:stable"

	// DefaultKzipToolLocation is the location of tools/kzip binary defined in
	// the gcr.io/kythe-public/kzip-tools image.
	DefaultKzipToolLocation = "/opt/kythe/tools/kzip"

	// GCRGitImage an image that runs git.
	GCRGitImage = "gcr.io/cloud-builders/git"
	// BazelImage extracts a repo using bazel.  See kythe/extractors/bazel.
	BazelImage = "gcr.io/kythe-public/bazel-extractor:stable"
	// GradleJDK8Image is an image wrapped around java8, which runs gradle.
	// MvnJDK8Image is an image wrapped around java8, which runs mvn.
	// See https://hub.docker.com/_/gradle for details on supported images.
	GradleJDK8Image = "gradle:5.2.1-jdk8-slim"
	// MvnJDK8Image is an image wrapped around java8, which runs mvn.
	// See https://hub.docker.com/_/maven for details on supported images.
	MvnJDK8Image = "maven:3.6.0-jdk-8-slim"
	// MvnJDK11Image is an image wrapped around java11, which runs mvn.
	// See https://hub.docker.com/_/maven for details on supported images.
	// TODO(#3075): support jdk 11
	MvnJDK11Image = "maven:3.6.0-jdk-11-slim"

	// DefaultJavacLocation points to a common location for a javac binary.
	// The binary will usually be symlinked here.
	DefaultJavacLocation = "/usr/bin/javac"

	// RequiredJavaEnv is all of the enivornment variables required for
	// extracting a java corpus, including env vars common for all extractors.
	RequiredJavaEnv = append(requiredEnv,

		"JAVAC_EXTRACTOR_JAR",

		"REAL_JAVAC",

		"KYTHE_JAVA_RUNTIME_OPTIONS",

		"KYTHE_OUTPUT_FILE",
	)
)