Skip to content

Commit

Permalink
Rename modquery to mod
Browse files Browse the repository at this point in the history
- Since we're considering adding more subcommands that don't exactly "query", such as `bazel mod upgrade` etc.
- `bazel modquery show` is renamed to `bazel mod show_repo` (`show_extension` is unchanged)
- `bazel modquery tree` is renamed to `bazel mod graph`.

#15365

Co-authored-by: Xùdōng Yáng <wyverald@gmail.com>
PiperOrigin-RevId: 547553222
Change-Id: I74145fdb87c05761692391e6ba47ce8d975f90a9
  • Loading branch information
2 people authored and Copybara-Service committed Jul 12, 2023
1 parent 5a502a1 commit f6c2ef9
Show file tree
Hide file tree
Showing 25 changed files with 276 additions and 283 deletions.
Expand Up @@ -51,7 +51,7 @@
import com.google.devtools.build.lib.bazel.bzlmod.SingleExtensionUsagesFunction;
import com.google.devtools.build.lib.bazel.bzlmod.YankedVersionsUtil;
import com.google.devtools.build.lib.bazel.commands.FetchCommand;
import com.google.devtools.build.lib.bazel.commands.ModqueryCommand;
import com.google.devtools.build.lib.bazel.commands.ModCommand;
import com.google.devtools.build.lib.bazel.commands.SyncCommand;
import com.google.devtools.build.lib.bazel.repository.LocalConfigPlatformFunction;
import com.google.devtools.build.lib.bazel.repository.LocalConfigPlatformRule;
Expand Down Expand Up @@ -206,7 +206,7 @@ public byte[] get(
@Override
public void serverInit(OptionsParsingResult startupOptions, ServerBuilder builder) {
builder.addCommands(new FetchCommand());
builder.addCommands(new ModqueryCommand());
builder.addCommands(new ModCommand());
builder.addCommands(new SyncCommand());
builder.addInfoItems(new RepositoryCacheInfoItem(repositoryCache));
}
Expand Down
Expand Up @@ -8,7 +8,7 @@ package(
filegroup(
name = "srcs",
srcs = glob(["*"]) + [
"//src/main/java/com/google/devtools/build/lib/bazel/bzlmod/modquery:srcs",
"//src/main/java/com/google/devtools/build/lib/bazel/bzlmod/modcommand:srcs",
],
visibility = ["//src:__subpackages__"],
)
Expand Down
Expand Up @@ -12,7 +12,7 @@ filegroup(
)

java_library(
name = "modquery",
name = "modcommand",
srcs = glob(["*.java"]),
deps = [
"//src/main/java/com/google/devtools/build/lib/bazel/bzlmod:common",
Expand Down
Expand Up @@ -11,7 +11,7 @@
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.bazel.bzlmod.modquery;
package com.google.devtools.build.lib.bazel.bzlmod.modcommand;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableBiMap;
Expand All @@ -22,12 +22,12 @@
import com.google.devtools.build.lib.bazel.bzlmod.BazelModuleInspectorValue.AugmentedModule;
import com.google.devtools.build.lib.bazel.bzlmod.ModuleExtensionId;
import com.google.devtools.build.lib.bazel.bzlmod.ModuleKey;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModuleArg.ModuleArgConverter;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModuleArg.ModuleArgConverter;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.Label.RepoContext;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.cmdline.RepositoryMapping;
import com.google.devtools.build.lib.server.FailureDetails.ModqueryCommand.Code;
import com.google.devtools.build.lib.server.FailureDetails.ModCommand.Code;
import com.google.devtools.common.options.Converter;
import com.google.devtools.common.options.Converters.CommaSeparatedNonEmptyOptionListConverter;
import com.google.devtools.common.options.OptionsParsingException;
Expand Down
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.bazel.bzlmod.modquery;
package com.google.devtools.build.lib.bazel.bzlmod.modcommand;

import static com.google.common.collect.ImmutableSortedSet.toImmutableSortedSet;

Expand All @@ -22,11 +22,11 @@
import com.google.devtools.build.lib.bazel.bzlmod.ModuleExtensionId;
import com.google.devtools.build.lib.bazel.bzlmod.ModuleKey;
import com.google.devtools.build.lib.bazel.bzlmod.Version;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.IsIndirect;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.NodeMetadata;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryOptions.ExtensionShow;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.OutputFormatters.OutputFormatter;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.IsIndirect;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.NodeMetadata;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModOptions.ExtensionShow;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.OutputFormatters.OutputFormatter;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.HashSet;
Expand All @@ -35,8 +35,8 @@
import java.util.Set;

/**
* Outputs graph-based results of {@link ModqueryExecutor} in the Graphviz <i>dot</i> format which
* can be further pipelined to create an image graph visualization.
* Outputs graph-based results of {@link ModExecutor} in the Graphviz <i>dot</i> format which can be
* further pipelined to create an image graph visualization.
*/
public class GraphvizOutputFormatter extends OutputFormatter {
private StringBuilder str;
Expand Down
Expand Up @@ -13,9 +13,9 @@
// limitations under the License.
//

package com.google.devtools.build.lib.bazel.bzlmod.modquery;
package com.google.devtools.build.lib.bazel.bzlmod.modcommand;

import com.google.devtools.build.lib.server.FailureDetails.ModqueryCommand.Code;
import com.google.devtools.build.lib.server.FailureDetails.ModCommand.Code;

/**
* Exception thrown when a user-input argument is invalid (wrong number of arguments or the
Expand Down
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.bazel.bzlmod.modquery;
package com.google.devtools.build.lib.bazel.bzlmod.modcommand;

import static com.google.common.collect.ImmutableSortedSet.toImmutableSortedSet;

Expand All @@ -21,21 +21,21 @@
import com.google.devtools.build.lib.bazel.bzlmod.BazelModuleInspectorValue.AugmentedModule;
import com.google.devtools.build.lib.bazel.bzlmod.ModuleExtensionId;
import com.google.devtools.build.lib.bazel.bzlmod.ModuleKey;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.IsCycle;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.IsExpanded;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.IsIndirect;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.NodeMetadata;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryOptions.ExtensionShow;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.OutputFormatters.OutputFormatter;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.IsCycle;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.IsExpanded;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.IsIndirect;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.NodeMetadata;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModOptions.ExtensionShow;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.OutputFormatters.OutputFormatter;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import java.util.HashSet;
import java.util.Map.Entry;
import java.util.Set;

/** Outputs graph-based results of {@link ModqueryExecutor} in JSON format. */
/** Outputs graph-based results of {@link ModExecutor} in JSON format. */
public class JsonOutputFormatter extends OutputFormatter {
private Set<ModuleExtensionId> seenExtensions;

Expand Down
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.bazel.bzlmod.modquery;
package com.google.devtools.build.lib.bazel.bzlmod.modcommand;

import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static com.google.common.collect.ImmutableSortedMap.toImmutableSortedMap;
Expand All @@ -35,9 +35,9 @@
import com.google.devtools.build.lib.bazel.bzlmod.ModuleKey;
import com.google.devtools.build.lib.bazel.bzlmod.Tag;
import com.google.devtools.build.lib.bazel.bzlmod.Version;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.IsExpanded;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.IsIndirect;
import com.google.devtools.build.lib.bazel.bzlmod.modquery.ModqueryExecutor.ResultNode.NodeMetadata;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.IsExpanded;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.IsIndirect;
import com.google.devtools.build.lib.bazel.bzlmod.modcommand.ModExecutor.ResultNode.NodeMetadata;
import com.google.devtools.build.lib.packages.RawAttributeMapper;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.query2.query.output.BuildOutputFormatter.AttributeReader;
Expand All @@ -62,23 +62,23 @@
import net.starlark.java.eval.Starlark;

/**
* Executes inspection queries for {@link
* com.google.devtools.build.lib.bazel.commands.ModqueryCommand} and prints the resulted output to
* the reporter's output stream using the different defined {@link OutputFormatters}.
* Executes inspection queries for {@link com.google.devtools.build.lib.bazel.commands.ModCommand}
* and prints the resulted output to the reporter's output stream using the different defined {@link
* OutputFormatters}.
*/
public class ModqueryExecutor {
public class ModExecutor {

private final ImmutableMap<ModuleKey, AugmentedModule> depGraph;
private final ImmutableTable<ModuleExtensionId, ModuleKey, ModuleExtensionUsage> extensionUsages;
private final ImmutableSetMultimap<ModuleExtensionId, String> extensionRepos;
private final Optional<MaybeCompleteSet<ModuleExtensionId>> extensionFilter;
private final ModqueryOptions options;
private final ModOptions options;
private final PrintWriter printer;
private ImmutableMap<ModuleExtensionId, ImmutableSetMultimap<String, ModuleKey>>
extensionRepoImports;

public ModqueryExecutor(
ImmutableMap<ModuleKey, AugmentedModule> depGraph, ModqueryOptions options, Writer writer) {
public ModExecutor(
ImmutableMap<ModuleKey, AugmentedModule> depGraph, ModOptions options, Writer writer) {
this(
depGraph,
ImmutableTable.of(),
Expand All @@ -88,12 +88,12 @@ public ModqueryExecutor(
writer);
}

public ModqueryExecutor(
public ModExecutor(
ImmutableMap<ModuleKey, AugmentedModule> depGraph,
ImmutableTable<ModuleExtensionId, ModuleKey, ModuleExtensionUsage> extensionUsages,
ImmutableSetMultimap<ModuleExtensionId, String> extensionRepos,
Optional<MaybeCompleteSet<ModuleExtensionId>> extensionFilter,
ModqueryOptions options,
ModOptions options,
Writer writer) {
this.depGraph = depGraph;
this.extensionUsages = extensionUsages;
Expand All @@ -106,7 +106,7 @@ public ModqueryExecutor(
this.extensionRepoImports = computeRepoImportsTable(depGraph.keySet());
}

public void tree(ImmutableSet<ModuleKey> from) {
public void graph(ImmutableSet<ModuleKey> from) {
ImmutableMap<ModuleKey, ResultNode> result =
expandAndPrune(from, computeExtensionFilterTargets(), false);
OutputFormatters.getFormatter(options.outputFormat)
Expand All @@ -129,7 +129,7 @@ public void allPaths(ImmutableSet<ModuleKey> from, ImmutableSet<ModuleKey> to) {
.output(result, depGraph, extensionRepos, extensionRepoImports, printer, options);
}

public void show(ImmutableMap<String, BzlmodRepoRuleValue> targetRepoRuleValues) {
public void showRepo(ImmutableMap<String, BzlmodRepoRuleValue> targetRepoRuleValues) {
RuleDisplayOutputter outputter = new RuleDisplayOutputter(printer);
for (Entry<String, BzlmodRepoRuleValue> e : targetRepoRuleValues.entrySet()) {
printer.printf("## %s:\n", e.getKey());
Expand Down Expand Up @@ -230,9 +230,9 @@ private class ResultGraphPruner {
/**
* Constructs a ResultGraphPruner to prune the result graph after the specified depth.
*
* @param targets If not complete, it means that the result tree contains paths to some specific
* targets. This will cause some branches to contain, after the specified depths, some
* targets or target parents. As any other nodes omitted, transitive edges (embedding
* @param targets If not complete, it means that the result graph contains paths to some
* specific targets. This will cause some branches to contain, after the specified depths,
* some targets or target parents. As any other nodes omitted, transitive edges (embedding
* multiple edges) will be stored as <i>indirect</i>.
* @param oldResult The unpruned result graph.
*/
Expand Down Expand Up @@ -559,8 +559,7 @@ public abstract static class NodeMetadata {

private static NodeMetadata create(
IsExpanded isExpanded, IsIndirect isIndirect, IsCycle isCycle) {
return new AutoValue_ModqueryExecutor_ResultNode_NodeMetadata(
isExpanded, isIndirect, isCycle);
return new AutoValue_ModExecutor_ResultNode_NodeMetadata(isExpanded, isIndirect, isCycle);
}
}

Expand All @@ -583,7 +582,7 @@ public ImmutableSortedSet<Entry<ModuleKey, NodeMetadata>> getChildrenSortedByEdg
}

static ResultNode.Builder builder() {
return new AutoValue_ModqueryExecutor_ResultNode.Builder().setTarget(false);
return new AutoValue_ModExecutor_ResultNode.Builder().setTarget(false);
}

@AutoValue.Builder
Expand Down

0 comments on commit f6c2ef9

Please sign in to comment.