gnodet-bot commented on code in PR #13094: URL: https://github.com/apache/maven/pull/13094#discussion_r4273507032
########## its/core-it-suite/src/test/resources/mng-8766-spi-workspace-reader/extension/src/main/java/org/apache/maven/its/extensions/TestSpiWorkspaceReader.java: ########## @@ -0,0 +1,113 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.maven.its.extensions; + +import java.io.IOException; +import java.io.OutputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Collections; +import java.util.List; +import java.util.Optional; + +import org.apache.maven.api.Artifact; +import org.apache.maven.api.di.Named; +import org.apache.maven.api.spi.WorkspaceReader; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Named("test-ide") +public class TestSpiWorkspaceReader implements WorkspaceReader { + + private static final Logger log = LoggerFactory.getLogger(TestSpiWorkspaceReader.class); + + /** + * GAV of the synthetic artifact served by this workspace reader. + * The test project declares a dependency on this artifact. + */ + private static final String SYNTHETIC_GROUP = "org.apache.maven.its.mng8766"; + + private static final String SYNTHETIC_ARTIFACT = "virtual-dep"; + private static final String SYNTHETIC_VERSION = "1.0"; + + public TestSpiWorkspaceReader() { + log.info("[SPI-WR] created"); + } + + @Override + public Optional<Path> findArtifact(Artifact artifact) { + log.info("[SPI-WR] findArtifact({})", artifact.key()); + if (isSyntheticArtifact(artifact)) { + try { + // Return a minimal (empty) jar file so the resolver can satisfy the dependency + Path jar = Files.createTempFile("mng8766-virtual-dep", ".jar"); + jar.toFile().deleteOnExit(); + // Write a valid empty ZIP/jar (4 bytes: end-of-central-directory signature) + try (OutputStream os = Files.newOutputStream(jar)) { + os.write(new byte[] {0x50, 0x4B, 0x05, 0x06, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}); + } + log.info("[SPI-WR] findArtifact: returning synthetic jar for {}", artifact.key()); + return Optional.of(jar); + } catch (IOException e) { + log.warn("[SPI-WR] could not create synthetic jar: {}", e.getMessage()); + } + } + return Optional.empty(); + } + + @Override + public List<String> findVersions(Artifact artifact) { + log.info("[SPI-WR] findVersions({})", artifact.key()); + if (SYNTHETIC_GROUP.equals(artifact.getGroupId()) && SYNTHETIC_ARTIFACT.equals(artifact.getArtifactId())) { Review Comment: ⚠️ **Deprecated API** — `getGroupId()` and `getArtifactId()` are `@Deprecated(since = "4.1.0", forRemoval = true)`. This IT extension is the canonical example of WorkspaceReader SPI usage that implementors will copy — it should use the noun-style API. ```suggestion if (SYNTHETIC_GROUP.equals(artifact.groupId()) && SYNTHETIC_ARTIFACT.equals(artifact.artifactId())) { ``` ########## its/core-it-suite/src/test/resources/mng-8766-spi-workspace-reader/extension/src/main/java/org/apache/maven/its/extensions/TestSpiWorkspaceReader.java: ########## @@ -0,0 +1,113 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.maven.its.extensions; + +import java.io.IOException; +import java.io.OutputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Collections; +import java.util.List; +import java.util.Optional; + +import org.apache.maven.api.Artifact; +import org.apache.maven.api.di.Named; +import org.apache.maven.api.spi.WorkspaceReader; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Named("test-ide") +public class TestSpiWorkspaceReader implements WorkspaceReader { + + private static final Logger log = LoggerFactory.getLogger(TestSpiWorkspaceReader.class); + + /** + * GAV of the synthetic artifact served by this workspace reader. + * The test project declares a dependency on this artifact. + */ + private static final String SYNTHETIC_GROUP = "org.apache.maven.its.mng8766"; + + private static final String SYNTHETIC_ARTIFACT = "virtual-dep"; + private static final String SYNTHETIC_VERSION = "1.0"; + + public TestSpiWorkspaceReader() { + log.info("[SPI-WR] created"); + } + + @Override + public Optional<Path> findArtifact(Artifact artifact) { + log.info("[SPI-WR] findArtifact({})", artifact.key()); + if (isSyntheticArtifact(artifact)) { + try { + // Return a minimal (empty) jar file so the resolver can satisfy the dependency + Path jar = Files.createTempFile("mng8766-virtual-dep", ".jar"); + jar.toFile().deleteOnExit(); + // Write a valid empty ZIP/jar (4 bytes: end-of-central-directory signature) + try (OutputStream os = Files.newOutputStream(jar)) { + os.write(new byte[] {0x50, 0x4B, 0x05, 0x06, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}); + } + log.info("[SPI-WR] findArtifact: returning synthetic jar for {}", artifact.key()); + return Optional.of(jar); + } catch (IOException e) { + log.warn("[SPI-WR] could not create synthetic jar: {}", e.getMessage()); + } + } + return Optional.empty(); + } + + @Override + public List<String> findVersions(Artifact artifact) { + log.info("[SPI-WR] findVersions({})", artifact.key()); + if (SYNTHETIC_GROUP.equals(artifact.getGroupId()) && SYNTHETIC_ARTIFACT.equals(artifact.getArtifactId())) { + return Collections.singletonList(SYNTHETIC_VERSION); + } + return Collections.emptyList(); + } + + @Override + public Optional<Path> findModel(Artifact artifact) { + log.info("[SPI-WR] findModel({})", artifact.key()); + if (isSyntheticArtifact(artifact)) { + try { + Path pom = Files.createTempFile("mng8766-virtual-dep", ".pom"); + pom.toFile().deleteOnExit(); + String pomContent = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" + + "<project xmlns=\"http://maven.apache.org/POM/4.0.0\";>\n" + + " <modelVersion>4.0.0</modelVersion>\n" + + " <groupId>" + SYNTHETIC_GROUP + "</groupId>\n" + + " <artifactId>" + SYNTHETIC_ARTIFACT + "</artifactId>\n" + + " <version>" + SYNTHETIC_VERSION + "</version>\n" + + " <packaging>jar</packaging>\n" + + "</project>\n"; + Files.writeString(pom, pomContent); + log.info("[SPI-WR] findModel: returning synthetic POM for {}", artifact.key()); + return Optional.of(pom); + } catch (IOException e) { + log.warn("[SPI-WR] could not create synthetic POM: {}", e.getMessage()); + } + } + return Optional.empty(); + } + + private static boolean isSyntheticArtifact(Artifact artifact) { + return SYNTHETIC_GROUP.equals(artifact.getGroupId()) + && SYNTHETIC_ARTIFACT.equals(artifact.getArtifactId()) + && SYNTHETIC_VERSION.equals(artifact.getVersion().toString()); Review Comment: ⚠️ **Deprecated API** — same issue in `isSyntheticArtifact()`: `getGroupId()`, `getArtifactId()`, `getVersion()` are all `@Deprecated(since = "4.1.0", forRemoval = true)`. ```suggestion return SYNTHETIC_GROUP.equals(artifact.groupId()) && SYNTHETIC_ARTIFACT.equals(artifact.artifactId()) && SYNTHETIC_VERSION.equals(artifact.version().toString()); ``` -- 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]
