-
Notifications
You must be signed in to change notification settings - Fork 304
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement py code generation handling
It is possible to write Bazel rules that generate Python code and act as a `py_library`. The plugin is augmented with this change to have a means of detecting these sort of rules and be able to work with them.
- Loading branch information
1 parent
66f5130
commit 6788b8e
Showing
22 changed files
with
1,230 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
base/src/com/google/idea/blaze/base/dependencies/BlazeQueryTargetTagFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| /* | ||
| * Copyright 2024 The Bazel Authors. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * 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.idea.blaze.base.dependencies; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.idea.blaze.base.bazel.BuildSystem; | ||
| import com.google.idea.blaze.base.bazel.BuildSystem.BuildInvoker; | ||
| import com.google.idea.blaze.base.command.BlazeCommand; | ||
| import com.google.idea.blaze.base.command.BlazeCommandName; | ||
| import com.google.idea.blaze.base.command.BlazeFlags; | ||
| import com.google.idea.blaze.base.command.buildresult.BuildResultHelper; | ||
| import com.google.idea.blaze.base.model.primitives.Label; | ||
| import com.google.idea.blaze.base.model.primitives.TargetExpression; | ||
| import com.google.idea.blaze.base.scope.BlazeContext; | ||
| import com.google.idea.blaze.base.settings.Blaze; | ||
| import com.google.idea.blaze.exception.BuildException; | ||
| import com.intellij.openapi.diagnostic.Logger; | ||
| import com.intellij.openapi.project.Project; | ||
| import com.intellij.openapi.util.SystemInfo; | ||
| import java.io.BufferedReader; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.InputStreamReader; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.regex.Pattern; | ||
| import java.util.stream.Collectors; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| /** | ||
| * This class is able to filter a list of targets selecting those that are | ||
| * tagged with one or more of a number of tags. | ||
| */ | ||
|
|
||
| public class BlazeQueryTargetTagFilter implements TargetTagFilter { | ||
|
|
||
| private static final Logger logger = | ||
| Logger.getInstance(BlazeQueryTargetTagFilter.class); | ||
|
|
||
| /** | ||
| * Tags are checked against this {@link Pattern} to ensure they can be used with | ||
| * the Bazel queries run in this logic. See | ||
| * {@link com.google.idea.blaze.base.ideinfo.Tags} for example Tags that would | ||
| * be used inside the Plugin; all of which conform to this {@link Pattern}. | ||
| */ | ||
| private static final Pattern PATTERN_TAG = Pattern.compile("^[a-zA-Z0-9_-]+$"); | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public List<TargetExpression> doFilterCodeGen( | ||
| Project project, | ||
| BlazeContext context, | ||
| List<TargetExpression> targets, | ||
| Set<String> tags) { | ||
|
|
||
| if (targets.isEmpty() || tags.isEmpty()) { | ||
| return ImmutableList.of(); | ||
| } | ||
|
|
||
| return runQuery(project, getQueryString(targets, tags), context); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| public static String getQueryString(List<TargetExpression> targets, Set<String> tags) { | ||
| Preconditions.checkArgument(null != targets && !targets.isEmpty(), "the targets must be supplied"); | ||
| Preconditions.checkArgument(null != tags && !tags.isEmpty(), "the tags must be supplied"); | ||
|
|
||
| for (String tag : tags) { | ||
| if (!PATTERN_TAG.matcher(tag).matches()) { | ||
| throw new IllegalStateException("the tag [" + tag + "] is not able to be used for filtering"); | ||
| } | ||
| } | ||
|
|
||
| String targetsExpression = targets.stream().map(Object::toString).collect(Collectors.joining(" + ")); | ||
| String matchExpression = String.format("[\\[ ](%s)[,\\]]", String.join("|", ImmutableList.sortedCopyOf(tags))); | ||
|
|
||
| if (SystemInfo.isWindows) { | ||
| return String.format("attr('tags', '%s', %s)", matchExpression, targetsExpression); | ||
| } | ||
|
|
||
| return String.format("attr(\"tags\", \"%s\", %s)", matchExpression, targetsExpression); | ||
| } | ||
|
|
||
| @javax.annotation.Nullable | ||
| private static List<TargetExpression> runQuery( | ||
| Project project, | ||
| String query, | ||
| BlazeContext context) { | ||
|
|
||
| BuildSystem buildSystem = Blaze.getBuildSystemProvider(project).getBuildSystem(); | ||
|
|
||
| BlazeCommand.Builder command = | ||
| BlazeCommand.builder( | ||
| buildSystem.getDefaultInvoker(project, context), BlazeCommandName.QUERY) | ||
| .addBlazeFlags("--output=label") | ||
| .addBlazeFlags(BlazeFlags.KEEP_GOING) | ||
| .addBlazeFlags(query); | ||
|
|
||
| BuildInvoker invoker = buildSystem.getDefaultInvoker(project, context); | ||
|
|
||
| try (BuildResultHelper helper = invoker.createBuildResultHelper(); | ||
| InputStream queryResultStream = invoker.getCommandRunner() | ||
| .runQuery(project, command, helper, context)) { | ||
|
|
||
| return new BufferedReader(new InputStreamReader(queryResultStream, UTF_8)) | ||
| .lines() | ||
| .map(Label::createIfValid) | ||
| .collect(Collectors.toList()); | ||
|
|
||
| } catch (IOException | BuildException e) { | ||
| logger.error(e.getMessage(), e); | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| } |
74 changes: 74 additions & 0 deletions
74
base/src/com/google/idea/blaze/base/dependencies/TargetTagFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Copyright 2024 The Bazel Authors. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * 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.idea.blaze.base.dependencies; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.idea.blaze.base.model.primitives.TargetExpression; | ||
| import com.google.idea.blaze.base.scope.BlazeContext; | ||
| import com.intellij.openapi.extensions.ExtensionPointName; | ||
| import com.intellij.openapi.project.Project; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Implementations of this interface are able to filter targets for having | ||
| * one of a set of tags. | ||
| */ | ||
|
|
||
| public interface TargetTagFilter { | ||
|
|
||
| ExtensionPointName<TargetTagFilter> EP_NAME = | ||
| ExtensionPointName.create("com.google.idea.blaze.TargetTagFilter"); | ||
|
|
||
| static boolean hasProvider() { | ||
| return EP_NAME.getExtensions().length != 0; | ||
| } | ||
|
|
||
| /** | ||
| * This method will run a Bazel query to select for those targets having a tag | ||
| * which matches one of the supplied {@code tags}. | ||
| * | ||
| * @param tags is a list of tags that targets are expected to have configured in | ||
| * order to be filtered in. | ||
| * @param targets is a list of Bazel targets to filter. | ||
| * @return a subset of the supplied targets that include one of the supplied {code tags}. | ||
| */ | ||
| static List<TargetExpression> filterCodeGen( | ||
| Project project, | ||
| BlazeContext context, | ||
| List<TargetExpression> targets, | ||
| Set<String> tags) { | ||
| return Arrays.stream(EP_NAME.getExtensions()) | ||
| .map(p -> p.doFilterCodeGen(project, context, targets, tags)) | ||
| .filter(Objects::nonNull) | ||
| .findFirst() | ||
| .orElse(ImmutableList.of()); | ||
| } | ||
|
|
||
| /** | ||
| * {@see #filterCodeGen} | ||
| */ | ||
| @Nullable | ||
| List<TargetExpression> doFilterCodeGen( | ||
| Project project, | ||
| BlazeContext context, | ||
| List<TargetExpression> targets, | ||
| Set<String> tags); | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.