/*
* Copyright 2010 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.ivyservice.moduleconverter.dependencies;
import org.apache.ivy.core.module.descriptor.DefaultExcludeRule;
import org.apache.ivy.core.module.descriptor.DefaultModuleDescriptor;
import org.apache.ivy.core.module.descriptor.DependencyArtifactDescriptor;
import org.apache.ivy.core.module.descriptor.DependencyDescriptor;
import org.apache.ivy.core.module.id.ArtifactId;
import org.apache.ivy.plugins.matcher.ExactPatternMatcher;
import org.apache.ivy.plugins.matcher.PatternMatcher;
import org.gradle.api.artifacts.Dependency;
import org.gradle.api.artifacts.DependencyArtifact;
import org.gradle.api.artifacts.ExcludeRule;
import org.gradle.api.artifacts.ModuleDependency;
import org.gradle.api.internal.artifacts.dependencies.DefaultDependencyArtifact;
import org.gradle.api.internal.artifacts.ivyservice.IvyUtil;
import org.gradle.api.internal.artifacts.ivyservice.moduleconverter.ExcludeRuleConverter;
import org.gradle.util.TestUtil;
import org.gradle.util.WrapUtil;
import org.jmock.Expectations;
import org.jmock.integration.junit4.JMock;
import org.jmock.integration.junit4.JUnit4Mockery;
import org.junit.Before;
import org.junit.runner.RunWith;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.List;
import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
@RunWith(JMock.class)
public abstract class AbstractDependencyDescriptorFactoryInternalTest {
private JUnit4Mockery context = new JUnit4Mockery();
protected static final String TEST_CONF = "conf";
protected static final String TEST_DEP_CONF = "depconf1";
protected static final ExcludeRule TEST_EXCLUDE_RULE = new org.gradle.api.internal.artifacts.DefaultExcludeRule("testOrg", null);
protected static final org.apache.ivy.core.module.descriptor.ExcludeRule TEST_IVY_EXCLUDE_RULE = getTestExcludeRule();
protected ExcludeRuleConverter excludeRuleConverterStub = context.mock(ExcludeRuleConverter.class);
protected final DefaultModuleDescriptor moduleDescriptor = TestUtil.createModuleDescriptor(WrapUtil.toSet(TEST_CONF));
private DefaultDependencyArtifact artifact = new DefaultDependencyArtifact("name", "type", null, null, null);
private DefaultDependencyArtifact artifactWithClassifiers = new DefaultDependencyArtifact("name2", "type2", "ext2", "classifier2", "http://www.url2.com");
@Before
public void setUp() {
expectExcludeRuleConversion(TEST_EXCLUDE_RULE, TEST_IVY_EXCLUDE_RULE);
}
protected void expectExcludeRuleConversion(final ExcludeRule excludeRule, final org.apache.ivy.core.module.descriptor.ExcludeRule ivyExcludeRule) {
context.checking(new Expectations() {{
allowing(excludeRuleConverterStub).createExcludeRule(TEST_CONF, excludeRule);
will(returnValue(ivyExcludeRule));
}});
}
protected Dependency setUpDependency(ModuleDependency dependency) {
return dependency.addArtifact(artifact).
addArtifact(artifactWithClassifiers).
exclude(WrapUtil.toMap("group", TEST_EXCLUDE_RULE.getGroup())).
setTransitive(true);
}
protected void assertDependencyDescriptorHasCommonFixtureValues(DependencyDescriptor dependencyDescriptor) {
assertThat(dependencyDescriptor.getParentRevisionId(), equalTo(moduleDescriptor.getModuleRevisionId()));
assertEquals(TEST_IVY_EXCLUDE_RULE, dependencyDescriptor.getExcludeRules(TEST_CONF)[0]);
assertThat(dependencyDescriptor.getDependencyConfigurations(TEST_CONF), equalTo(WrapUtil.toArray(TEST_DEP_CONF)));
assertThat(dependencyDescriptor.isTransitive(), equalTo(true));
assertDependencyDescriptorHasArtifacts(dependencyDescriptor);
}
private void assertDependencyDescriptorHasArtifacts(DependencyDescriptor dependencyDescriptor) {
List<DependencyArtifactDescriptor> artifactDescriptors = WrapUtil.toList(dependencyDescriptor.getDependencyArtifacts(TEST_CONF));
assertThat(artifactDescriptors.size(), equalTo(2));
DependencyArtifactDescriptor artifactDescriptorWithoutClassifier = findDescriptor(artifactDescriptors, artifact);
assertEquals(new HashMap(), artifactDescriptorWithoutClassifier.getExtraAttributes());
assertEquals(null, artifactDescriptorWithoutClassifier.getUrl());
compareArtifacts(artifact, artifactDescriptorWithoutClassifier);
assertEquals(artifact.getType(), artifactDescriptorWithoutClassifier.getExt());
DependencyArtifactDescriptor artifactDescriptorWithClassifierAndConfs = findDescriptor(artifactDescriptors, artifactWithClassifiers);
assertEquals(WrapUtil.toMap(Dependency.CLASSIFIER, artifactWithClassifiers.getClassifier()), artifactDescriptorWithClassifierAndConfs.getQualifiedExtraAttributes());
compareArtifacts(artifactWithClassifiers, artifactDescriptorWithClassifierAndConfs);
assertEquals(artifactWithClassifiers.getExtension(), artifactDescriptorWithClassifierAndConfs.getExt());
try {
assertEquals(new URL(artifactWithClassifiers.getUrl()), artifactDescriptorWithClassifierAndConfs.getUrl());
} catch (MalformedURLException e) {
throw new RuntimeException(e);
}
}
private DependencyArtifactDescriptor findDescriptor(List<DependencyArtifactDescriptor> artifactDescriptors, DefaultDependencyArtifact dependencyArtifact) {
for (DependencyArtifactDescriptor artifactDescriptor : artifactDescriptors) {
if (artifactDescriptor.getName().equals(dependencyArtifact.getName())) {
return artifactDescriptor;
}
}
throw new RuntimeException("Descriptor could not be found");
}
private void compareArtifacts(DependencyArtifact artifact, DependencyArtifactDescriptor artifactDescriptor) {
assertEquals(artifact.getName(), artifactDescriptor.getName());
assertEquals(artifact.getType(), artifactDescriptor.getType());
}
private static DefaultExcludeRule getTestExcludeRule() {
return new DefaultExcludeRule(new ArtifactId(
IvyUtil.createModuleId("org", "testOrg"), PatternMatcher.ANY_EXPRESSION,
PatternMatcher.ANY_EXPRESSION,
PatternMatcher.ANY_EXPRESSION),
ExactPatternMatcher.INSTANCE, null);
}
}