Recipe- BeansXmlNamespace (#355)

* BeansXmlNamespace * updated BeansXmlNamespace removing jvm values * Minimize implementation * Format tests to conform to project conventions * Format tests to conform to project conventions * update getDisplayName and getDescription --------- Co-authored-by: anuram <[email protected]> Co-authored-by: Tim te Beek <[email protected]>
openrewrite · Nov 21, 2023 · 564f486 · 564f486
1 parent f3e6775
commit 564f486
Show file tree

Hide file tree

Showing 2 changed files with 200 additions and 0 deletions.
diff --git a/src/main/java/org/openrewrite/java/migrate/BeansXmlNamespace.java b/src/main/java/org/openrewrite/java/migrate/BeansXmlNamespace.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2023 the original author or authors.
+ * <p>
+ * 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.openrewrite.java.migrate;
+
+import lombok.EqualsAndHashCode;
+import lombok.Value;
+import org.openrewrite.*;
+import org.openrewrite.xml.ChangeTagAttribute;
+import org.openrewrite.xml.XPathMatcher;
+import org.openrewrite.xml.XmlVisitor;
+import org.openrewrite.xml.tree.Xml;
+
+import java.util.Map;
+
+import static java.util.stream.Collectors.toMap;
+
+@Value
+@EqualsAndHashCode(callSuper = true)
+public class BeansXmlNamespace extends Recipe {
+
+    private static final XPathMatcher BEANS_MATCHER = new XPathMatcher("/beans");
+    private static final String NS_SUN = "http://java.sun.com/xml/ns/javaee";
+    private static final String NS_JCP = "http://xmlns.jcp.org/xml/ns/javaee";
+    private static final String SUN_SCHEMA_LOCATION = "http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/beans_1_0.xsd";
+    private static final String JCP_SCHEMA_LOCATION = "http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd";
+
+    @Override
+    public String getDisplayName() {
+        return "Change `beans.xml` `schemaLocation` to match XML namespace";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Set the `schemaLocation` that corresponds to the `xmlns` set in `beans.xml` files.";
+    }
+
+    @Override
+    public TreeVisitor<?, ExecutionContext> getVisitor() {
+        return Preconditions.check(new HasSourcePath<>("**/beans.xml"), new XmlVisitor<ExecutionContext>() {
+            @Override
+            public Xml visitTag(Xml.Tag tag, ExecutionContext ctx) {
+                Xml.Tag t = (Xml.Tag) super.visitTag(tag, ctx);
+                if (BEANS_MATCHER.matches(getCursor())) {
+                    Map<String, String> attributes = t.getAttributes().stream().collect(toMap(Xml.Attribute::getKeyAsString, Xml.Attribute::getValueAsString));
+                    String xmlns = attributes.get("xmlns");
+                    String schemaLocation = attributes.get("xsi:schemaLocation");
+                    if (NS_SUN.equalsIgnoreCase(xmlns) && !SUN_SCHEMA_LOCATION.equalsIgnoreCase(schemaLocation)) {
+                        doAfterVisit(new ChangeTagAttribute("beans", "xsi:schemaLocation", SUN_SCHEMA_LOCATION, null).getVisitor());
+                    } else if (NS_JCP.equalsIgnoreCase(xmlns) && !JCP_SCHEMA_LOCATION.equalsIgnoreCase(schemaLocation)) {
+                        doAfterVisit(new ChangeTagAttribute("beans", "xsi:schemaLocation", JCP_SCHEMA_LOCATION, null).getVisitor());
+                    }
+                }
+                return t;
+            }
+        });
+    }
+}
diff --git a/src/test/java/org/openrewrite/java/migrate/BeansXmlNamespaceTest.java b/src/test/java/org/openrewrite/java/migrate/BeansXmlNamespaceTest.java
@@ -0,0 +1,130 @@
+/*
+ * Copyright 2023 the original author or authors.
+ * <p>
+ * 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.openrewrite.java.migrate;
+
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.openrewrite.test.RecipeSpec;
+import org.openrewrite.test.RewriteTest;
+
+import static org.openrewrite.xml.Assertions.xml;
+
+class BeansXmlNamespaceTest implements RewriteTest {
+    @Override
+    public void defaults(RecipeSpec spec) {
+        spec.recipe(new BeansXmlNamespace());
+    }
+
+    @Test
+    void noSchemaCD1() {
+        rewriteRun(
+          //language=xml
+          xml(
+            """
+              <?xml version="1.0" encoding="UTF-8"?>
+              <beans xmlns="http://java.sun.com/xml/ns/javaee"
+                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                  xsi:schemaLocation="https://jakarta.ee/xml/ns/jakarXXtaee https://jakarta.ee/xml/ns/jakartaee/beans111_3_0.xsd">
+              </beans>
+              """,
+            """
+              <?xml version="1.0" encoding="UTF-8"?>
+              <beans xmlns="http://java.sun.com/xml/ns/javaee"
+                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/beans_1_0.xsd">
+              </beans>
+              """,
+            sourceSpecs -> sourceSpecs.path("beans.xml")
+          )
+        );
+    }
+
+    @Test
+    void noSchemaCD12() {
+        rewriteRun(
+          //language=xml
+          xml(
+            """
+              <?xml version="1.0" encoding="UTF-8"?>
+              <beans xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
+                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                 xsi:schemaLocation="http://xmlns.jcp.org/DDDDxml/ns/javaee22 http://xmlns.jcp.org11/xml/ns/javaee777/beans_1_1.xsd">
+              </beans> 
+              """,
+            """
+              <?xml version="1.0" encoding="UTF-8"?>
+              <beans xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
+                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                 xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd">
+              </beans> 
+              """,
+            sourceSpecs -> sourceSpecs.path("beans.xml")
+          )
+        );
+    }
+
+    @Nested
+    class NoChanges {
+        @Test
+        void fileNotNamedBeansXml() {
+            rewriteRun(
+              //language=xml
+              xml(
+                """
+                  <beans xmlns="http://java.sun.com/xml/ns/javaee" 
+                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/beans_1_0.xsd">
+                  </beans> 
+                  """,
+                sourceSpecs -> sourceSpecs.path("not-beans.xml")
+              )
+            );
+        }
+
+        @Test
+        void alreadyHasRightSchemaLocationSun() {
+            rewriteRun(
+              //language=xml
+              xml(
+                """
+                  <beans xmlns="http://java.sun.com/xml/ns/javaee" 
+                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/beans_1_0.xsd">
+                  </beans> 
+                  """,
+                sourceSpecs -> sourceSpecs.path("beans.xml")
+              )
+            );
+        }
+
+        @Test
+        void alreadyHasRightSchemaLocation() {
+            rewriteRun(
+              //language=xml
+              xml(
+                """
+                  <beans xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
+                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                      xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd" 
+                      bean-discovery-mode="all" version="1.1">
+                  </beans>
+                  """,
+                sourceSpecs -> sourceSpecs.path("beans.xml")
+              )
+            );
+        }
+    }
+}