diff --git a/maven/lib/dependabot/maven/file_updater.rb b/maven/lib/dependabot/maven/file_updater.rb index d8dea5a17aa..8f6e24044c7 100644 --- a/maven/lib/dependabot/maven/file_updater.rb +++ b/maven/lib/dependabot/maven/file_updater.rb @@ -11,7 +11,19 @@ module Dependabot module Maven - class FileUpdater < Dependabot::FileUpdaters::Base + class FileUpdater < Dependabot::FileUpdaters::Base # rubocop:disable Metrics/ClassLength + XML_TERMINATORS = T.let( + { "", " "?>", " "]]>" }.freeze, + T::Hash[String, String] + ) + + XML_TAG_SCANNER = %r{ + + |<\?.*?\?> + | + |<(/?)[^\s>/!?](?:"[^"]*"|'[^']*'|[^>"'])*?(/?)> + }mx + extend T::Sig require_relative "file_updater/declaration_finder" @@ -331,10 +343,48 @@ def declaration_finder(dependency, requirement) def updated_file_declaration(old_declaration, previous_req, requirement) original_req_string = T.must(previous_req.requirement_string) - old_declaration.gsub( - /(?<=\s|>)#{Regexp.quote(original_req_string)}(?=\s|<)/, - T.must(requirement.requirement_string) - ) + filler = /(?:\s|).)*-->|<\?(?:(?!\?>).)*\?>)*/m + own_version = %r{ + (<(?:[\w.-]+:)?version(?:\s(?:"[^"]*"|'[^']*'|[^>"'])*)?>#{filler}(?:)?#{filler}) + }mx + + # Only rewrite the declaration's own child; nested elements + # (e.g. plugin ) may contain the same text. + old_declaration.gsub(own_version) do + match = T.must(Regexp.last_match) + prefix = old_declaration[0...match.begin(0)].to_s + next match[0].to_s if inside_comment_or_cdata?(prefix) || element_depth(prefix) != 1 + + "#{match[1]}#{requirement.requirement_string}#{match[2]}" + end + end + + sig { params(xml_prefix: String).returns(T::Boolean) } + def inside_comment_or_cdata?(xml_prefix) + pos = 0 + while (match = xml_prefix.match(/" + ) + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("") + is_expected.to include("").and include("3.7.0") + is_expected.to include("3.6.3") + end + end + + context "with CDATA comments, processing instructions and quoted > before the plugin version" do + let(:pom_body) do + fixture("poms", "plugin_config_same_version.xml") + .sub("3.6.3\n ", "") + .sub( + "require-maven", + "require-maven b\"/> ?>" \ + "1.0]]>" + ) + .sub("", "\n 3.6.3") + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("3.7.0") + is_expected.to include("3.6.3") + end + end + + context "with a processing instruction containing the plugin version" do + let(:pom_body) do + fixture("poms", "plugin_config_same_version.xml") + .sub( + "maven-enforcer-plugin", + "maven-enforcer-plugin\n3.6.3 ?>" + ) + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("3.6.3 ?>") + is_expected.to include("3.7.0") + end + end + + context "with a CDATA-wrapped plugin version" do + let(:pom_body) do + fixture("poms", "plugin_config_same_version.xml") + .sub( + "3.6.3\n ", + "\n " + ) + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("") + is_expected.to include("3.6.3") + end + end + + context "with a whitespace-padded CDATA plugin version" do + let(:pom_body) do + fixture("poms", "plugin_config_same_version.xml") + .sub( + "3.6.3\n ", + "\n " + ) + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("") + is_expected.to include("3.6.3") + end + end + + context "with a namespace-prefixed plugin version" do + let(:pom_body) do + fixture("poms", "plugin_config_same_version.xml") + .sub("3.6.3\n ", "3.6.3\n ") + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("3.7.0") + is_expected.to include("3.6.3") + end + end + + context "with a plugin version with a quoted > in an attribute" do + let(:pom_body) do + fixture("poms", "plugin_config_same_version.xml") + .sub( + "3.6.3\n ", + "3.6.3\n " + ) + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("3.7.0") + is_expected.to include("3.6.3") + end + end + + context "with a plugin version adjacent to processing instructions" do + let(:pom_body) do + fixture("poms", "plugin_config_same_version.xml") + .sub( + "3.6.3\n ", + "3.6.3\n " + ) + end + let(:dependency) do + Dependabot::Dependency.new( + name: "org.apache.maven.plugins:maven-enforcer-plugin", + version: "3.7.0", + requirements: [{ + file: "pom.xml", requirement: "3.7.0", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + previous_requirements: [{ + file: "pom.xml", requirement: "3.6.3", groups: ["plugin"], source: nil, + metadata: { packaging_type: "jar" } + }], + package_manager: "maven" + ) + end + + its(:content) do + is_expected.to include("3.7.0") + is_expected.to include("3.6.3") + end + end + context "with a comment on the version" do let(:pom_body) { fixture("poms", "version_with_comment.xml") } diff --git a/maven/spec/fixtures/poms/plugin_config_same_version.xml b/maven/spec/fixtures/poms/plugin_config_same_version.xml new file mode 100644 index 00000000000..a157ab56c90 --- /dev/null +++ b/maven/spec/fixtures/poms/plugin_config_same_version.xml @@ -0,0 +1,26 @@ + + 4.0.0 + example + repro + 1.0.0 + + + + org.apache.maven.plugins + maven-enforcer-plugin + 3.6.3 + + + require-maven + enforce + + + 3.6.3 + + + + + + + +