org.gradle.api.internalrepositories.metadata.AbstractRepositoryMetadataSource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.5 API redistribution.
/*
* Copyright 2017 the original author or authors.
*
* 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 org.gradle.api.internal.artifacts.repositories.metadata;
import com.google.common.base.Joiner;
import org.gradle.api.artifacts.ModuleVersionIdentifier;
import org.gradle.api.artifacts.component.ModuleComponentIdentifier;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.ComponentResolvers;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.parser.DescriptorParseContext;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.parser.MetaDataParseException;
import org.gradle.api.internal.artifacts.ivyservice.ivyresolve.parser.MetaDataParser;
import org.gradle.api.internal.artifacts.repositories.resolver.ExternalResourceArtifactResolver;
import org.gradle.api.internal.artifacts.repositories.resolver.ExternalResourceResolver;
import org.gradle.api.internal.artifacts.repositories.resolver.ExternalResourceResolverDescriptorParseContext;
import org.gradle.internal.SystemProperties;
import org.gradle.internal.component.external.model.ModuleComponentArtifactMetadata;
import org.gradle.internal.component.external.model.MutableModuleComponentResolveMetadata;
import org.gradle.internal.component.model.ComponentOverrideMetadata;
import org.gradle.internal.component.model.DefaultModuleDescriptorArtifactMetadata;
import org.gradle.internal.component.model.IvyArtifactName;
import org.gradle.internal.component.model.ModuleDescriptorArtifactMetadata;
import org.gradle.internal.component.model.MutableModuleSources;
import org.gradle.internal.hash.ChecksumService;
import org.gradle.internal.hash.HashCode;
import org.gradle.internal.resolve.result.BuildableModuleComponentMetaDataResolveResult;
import org.gradle.internal.resolve.result.ResourceAwareResolveResult;
import org.gradle.internal.resource.local.FileResourceRepository;
import org.gradle.internal.resource.local.LocallyAvailableExternalResource;
import org.gradle.internal.resource.metadata.ExternalResourceMetaData;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nullable;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
abstract class AbstractRepositoryMetadataSource extends AbstractMetadataSource {
private static final Logger LOGGER = LoggerFactory.getLogger(ExternalResourceResolver.class);
final MetadataArtifactProvider metadataArtifactProvider;
private final FileResourceRepository fileResourceRepository;
private final ChecksumService checksumService;
protected AbstractRepositoryMetadataSource(MetadataArtifactProvider metadataArtifactProvider,
FileResourceRepository fileResourceRepository,
ChecksumService checksumService) {
this.metadataArtifactProvider = metadataArtifactProvider;
this.fileResourceRepository = fileResourceRepository;
this.checksumService = checksumService;
}
@Override
public S create(String repositoryName, ComponentResolvers componentResolvers, ModuleComponentIdentifier moduleVersionIdentifier, ComponentOverrideMetadata prescribedMetaData, ExternalResourceArtifactResolver artifactResolver, BuildableModuleComponentMetaDataResolveResult result) {
S parsedMetadataFromRepository = parseMetaDataFromArtifact(repositoryName, componentResolvers, moduleVersionIdentifier, artifactResolver, result);
if (parsedMetadataFromRepository != null) {
LOGGER.debug("Metadata file found for module '{}' in repository '{}'.", moduleVersionIdentifier, repositoryName);
}
return parsedMetadataFromRepository;
}
@Nullable
private S parseMetaDataFromArtifact(String repositoryName, ComponentResolvers componentResolvers, ModuleComponentIdentifier moduleComponentIdentifier, ExternalResourceArtifactResolver artifactResolver, ResourceAwareResolveResult result) {
ModuleComponentArtifactMetadata artifact = getMetaDataArtifactFor(moduleComponentIdentifier);
LocallyAvailableExternalResource metadataArtifact = artifactResolver.resolveArtifact(artifact, result);
if (metadataArtifact != null) {
ExternalResourceResolverDescriptorParseContext context = new ExternalResourceResolverDescriptorParseContext(componentResolvers, fileResourceRepository, checksumService);
MetaDataParser.ParseResult parseResult = parseMetaDataFromResource(moduleComponentIdentifier, metadataArtifact, artifactResolver, context, repositoryName);
if (parseResult != null) {
if (parseResult.hasGradleMetadataRedirectionMarker()) {
if (result instanceof BuildableModuleComponentMetaDataResolveResult) {
((BuildableModuleComponentMetaDataResolveResult) result).redirectToGradleMetadata();
} else {
throw new IllegalStateException("Unexpected Gradle metadata redirection answer");
}
}
S metadata = parseResult.getResult();
File metadataArtifactFile = metadataArtifact.getFile();
ExternalResourceMetaData metaData = metadataArtifact.getMetaData();
MutableModuleSources sources = metadata.getSources();
sources.add(new DefaultMetadataFileSource(artifact.getId(), metadataArtifactFile, findSha1(metaData, metadataArtifactFile)));
context.appendSources(sources);
return metadata;
}
}
return null;
}
private HashCode findSha1(ExternalResourceMetaData metaData, File artifact) {
HashCode sha1 = metaData.getSha1();
if (sha1 == null) {
sha1 = checksumService.sha1(artifact);
}
return sha1;
}
private ModuleDescriptorArtifactMetadata getMetaDataArtifactFor(ModuleComponentIdentifier moduleComponentIdentifier) {
IvyArtifactName ivyArtifactName = metadataArtifactProvider.getMetaDataArtifactName(moduleComponentIdentifier.getModule());
return new DefaultModuleDescriptorArtifactMetadata(moduleComponentIdentifier, ivyArtifactName);
}
void checkMetadataConsistency(ModuleComponentIdentifier expectedId, MutableModuleComponentResolveMetadata metadata) throws MetaDataParseException {
checkModuleIdentifier(expectedId, metadata.getModuleVersionId());
}
private void checkModuleIdentifier(ModuleComponentIdentifier expectedId, ModuleVersionIdentifier actualId) {
List errors = new ArrayList<>();
checkEquals("group", expectedId.getGroup(), actualId.getGroup(), errors);
checkEquals("module name", expectedId.getModule(), actualId.getName(), errors);
checkEquals("version", expectedId.getVersion(), actualId.getVersion(), errors);
if (errors.size() > 0) {
throw new MetaDataParseException(
String.format("inconsistent module metadata found. Descriptor: %s Errors: %s", actualId, joinLines(errors)));
}
}
private String joinLines(List lines) {
return Joiner.on(SystemProperties.getInstance().getLineSeparator()).join(lines);
}
private void checkEquals(String label, String expected, String actual, List errors) {
if (!expected.equals(actual)) {
errors.add("bad " + label + ": expected='" + expected + "' found='" + actual + "'");
}
}
protected abstract MetaDataParser.ParseResult parseMetaDataFromResource(ModuleComponentIdentifier moduleComponentIdentifier, LocallyAvailableExternalResource cachedResource, ExternalResourceArtifactResolver artifactResolver, DescriptorParseContext context, String repoName);
}