Skip to content

Commit

Permalink
[MNG-7814] Use location tracking for settings (#1164)
Browse files Browse the repository at this point in the history
  • Loading branch information
gnodet committed Jun 19, 2023
1 parent e6303aa commit 0a8491c
Show file tree
Hide file tree
Showing 12 changed files with 888 additions and 591 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,11 @@
package org.apache.maven.settings;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.nio.charset.StandardCharsets;
import java.io.InputStream;
import java.nio.file.Files;

import org.apache.maven.settings.v4.SettingsXpp3Reader;
import org.apache.maven.api.settings.InputSource;
import org.apache.maven.settings.v4.SettingsXpp3ReaderEx;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertTrue;
Expand All @@ -43,8 +42,8 @@ void testValidGlobalSettings() throws Exception {
File globalSettingsFile = new File(basedir, "src/assembly/maven/conf/settings.xml");
assertTrue(globalSettingsFile.isFile(), globalSettingsFile.getAbsolutePath());

try (Reader reader = new InputStreamReader(new FileInputStream(globalSettingsFile), StandardCharsets.UTF_8)) {
new SettingsXpp3Reader().read(reader);
try (InputStream is = Files.newInputStream(globalSettingsFile.toPath())) {
new SettingsXpp3ReaderEx().read(is, true, new InputSource(globalSettingsFile.getAbsolutePath()));
}
}
}
1 change: 1 addition & 0 deletions api/maven-api-settings/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ under the License.
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.settings</param>
<param>locationTracking=true</param>
</params>
</configuration>
</execution>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
/*
* 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.api.settings;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

/**
* Class InputLocation.
*/
public class InputLocation implements Serializable, InputLocationTracker {
private final int lineNumber;
private final int columnNumber;
private final InputSource source;
private final Map<Object, InputLocation> locations;

public InputLocation(InputSource source) {
this.lineNumber = -1;
this.columnNumber = -1;
this.source = source;
this.locations = Collections.singletonMap(0, this);
}

public InputLocation(int lineNumber, int columnNumber) {
this(lineNumber, columnNumber, null, null);
}

public InputLocation(int lineNumber, int columnNumber, InputSource source) {
this(lineNumber, columnNumber, source, null);
}

public InputLocation(int lineNumber, int columnNumber, InputSource source, Object selfLocationKey) {
this.lineNumber = lineNumber;
this.columnNumber = columnNumber;
this.source = source;
this.locations =
selfLocationKey != null ? Collections.singletonMap(selfLocationKey, this) : Collections.emptyMap();
}

public InputLocation(int lineNumber, int columnNumber, InputSource source, Map<Object, InputLocation> locations) {
this.lineNumber = lineNumber;
this.columnNumber = columnNumber;
this.source = source;
this.locations = ImmutableCollections.copy(locations);
}

public int getLineNumber() {
return lineNumber;
}

public int getColumnNumber() {
return columnNumber;
}

public InputSource getSource() {
return source;
}

public InputLocation getLocation(Object key) {
return locations != null ? locations.get(key) : null;
}

public Map<Object, InputLocation> getLocations() {
return locations;
}

/**
* Merges the {@code source} location into the {@code target} location.
*
* @param target the target location
* @param source the source location
* @param sourceDominant the boolean indicating of {@code source} is dominant compared to {@code target}
* @return the merged location
*/
public static InputLocation merge(InputLocation target, InputLocation source, boolean sourceDominant) {
if (source == null) {
return target;
} else if (target == null) {
return source;
}

Map<Object, InputLocation> locations;
Map<Object, InputLocation> sourceLocations = source.locations;
Map<Object, InputLocation> targetLocations = target.locations;
if (sourceLocations == null) {
locations = targetLocations;
} else if (targetLocations == null) {
locations = sourceLocations;
} else {
locations = new LinkedHashMap<>();
locations.putAll(sourceDominant ? targetLocations : sourceLocations);
locations.putAll(sourceDominant ? sourceLocations : targetLocations);
}

return new InputLocation(target.getLineNumber(), target.getColumnNumber(), target.getSource(), locations);
} // -- InputLocation merge( InputLocation, InputLocation, boolean )

/**
* Merges the {@code source} location into the {@code target} location.
* This method is used when the locations refer to lists and also merges the indices.
*
* @param target the target location
* @param source the source location
* @param indices the list of integers for the indices
* @return the merged location
*/
public static InputLocation merge(InputLocation target, InputLocation source, Collection<Integer> indices) {
if (source == null) {
return target;
} else if (target == null) {
return source;
}

Map<Object, InputLocation> locations;
Map<Object, InputLocation> sourceLocations = source.locations;
Map<Object, InputLocation> targetLocations = target.locations;
if (sourceLocations == null) {
locations = targetLocations;
} else if (targetLocations == null) {
locations = sourceLocations;
} else {
locations = new LinkedHashMap<>();
for (int index : indices) {
InputLocation location;
if (index < 0) {
location = sourceLocations.get(~index);
} else {
location = targetLocations.get(index);
}
locations.put(locations.size(), location);
}
}

return new InputLocation(target.getLineNumber(), target.getColumnNumber(), target.getSource(), locations);
} // -- InputLocation merge( InputLocation, InputLocation, java.util.Collection )

/**
* Class StringFormatter.
*
* @version $Revision$ $Date$
*/
public interface StringFormatter {

// -----------/
// - Methods -/
// -----------/

/**
* Method toString.
*/
String toString(InputLocation location);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
* 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.api.settings;

public interface InputLocationTracker {
InputLocation getLocation(Object field);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/*
* 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.api.settings;

import java.io.Serializable;

/**
* Class InputSource.
*/
public class InputSource implements Serializable {

private final String location;

public InputSource(String location) {
this.location = location;
}

/**
* Get the path/URL of the settings definition or {@code null} if unknown.
*
* @return the location
*/
public String getLocation() {
return this.location;
}

@Override
public String toString() {
return getLocation();
}
}
52 changes: 51 additions & 1 deletion api/maven-api-settings/src/main/mdo/settings.mdo
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@
</fields>
<codeSegments>
<codeSegment>
<version>1.0.0+</version>
<version>1.0.0/1.2.0</version>
<code>
<![CDATA[
public Boolean getInteractiveMode()
Expand Down Expand Up @@ -1082,5 +1082,55 @@
</fields>
</class>
<!-- /BuildProfile support -->
<class locationTracker="locations">
<name>InputLocation</name>
<version>2.0.0+</version>
<fields>
<!-- line, column and source fields are auto-generated by Modello -->
</fields>
<codeSegments>
<codeSegment>
<version>2.0.0+</version>
<code>
<![CDATA[
@Override
public String toString() {
return getLineNumber() + " : " + getColumnNumber() + ", " + getSource();
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
<class sourceTracker="source">
<name>InputSource</name>
<version>2.0.0+</version>
<fields>
<field>
<name>location</name>
<version>2.0.0+</version>
<type>String</type>
<description>
<![CDATA[
The path/URL of the settings definition or {@code null} if unknown.
]]>
</description>
</field>
</fields>
<codeSegments>
<codeSegment>
<version>2.0.0+</version>
<code>
<![CDATA[
@Override
public String toString() {
return getLocation();
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
</classes>
</model>
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@
import java.util.Objects;

import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.model.InputSource;
import org.apache.maven.api.services.xml.SettingsXmlFactory;
import org.apache.maven.api.services.xml.XmlReaderException;
import org.apache.maven.api.services.xml.XmlReaderRequest;
import org.apache.maven.api.services.xml.XmlWriterException;
import org.apache.maven.api.services.xml.XmlWriterRequest;
import org.apache.maven.api.settings.InputSource;
import org.apache.maven.api.settings.Settings;
import org.apache.maven.settings.v4.SettingsXpp3Reader;
import org.apache.maven.settings.v4.SettingsXpp3ReaderEx;
import org.apache.maven.settings.v4.SettingsXpp3Writer;

@Named
Expand All @@ -52,14 +52,14 @@ public Settings read(@Nonnull XmlReaderRequest request) throws XmlReaderExceptio
try {
InputSource source = null;
if (request.getModelId() != null || request.getLocation() != null) {
source = new InputSource(request.getModelId(), request.getLocation());
source = new InputSource(request.getLocation());
}
SettingsXpp3Reader xml = new SettingsXpp3Reader();
SettingsXpp3ReaderEx xml = new SettingsXpp3ReaderEx();
xml.setAddDefaultEntities(request.isAddDefaultEntities());
if (reader != null) {
return xml.read(reader, request.isStrict());
return xml.read(reader, request.isStrict(), source);
} else {
return xml.read(inputStream, request.isStrict());
return xml.read(inputStream, request.isStrict(), source);
}
} catch (Exception e) {
throw new XmlReaderException("Unable to read settings", e);
Expand Down
Loading

0 comments on commit 0a8491c

Please sign in to comment.