Start adding validation from schemas

jpenilla · Mar 23, 2024 · f8f4d7e · f8f4d7e
1 parent 4bd26f3
commit f8f4d7e
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 7 deletions.
diff --git a/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/bukkit/BukkitPluginYml.kt b/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/bukkit/BukkitPluginYml.kt
@@ -19,6 +19,7 @@ import xyz.jpenilla.resourcefactory.ResourceFactory
 import xyz.jpenilla.resourcefactory.util.ProjectMetaConventions
 import xyz.jpenilla.resourcefactory.util.nullAction
 import xyz.jpenilla.resourcefactory.util.nullIfEmpty
+import xyz.jpenilla.resourcefactory.util.validate
 
 fun Project.bukkitPluginYml(configure: Action<BukkitPluginYml> = nullAction()): BukkitPluginYml {
     val yml = BukkitPluginYml(objects)
@@ -166,9 +167,9 @@ class BukkitPluginYml(
     @ConfigSerializable
     class Serializable(yml: BukkitPluginYml) {
         val apiVersion = yml.apiVersion.orNull
-        val name = yml.name.get()
+        val name = yml.name.get().validate("Bukkit plugin name", "^[A-Za-z0-9_\\.-]+$")
         val version = yml.version.get()
-        val main = yml.main.get()
+        val main = yml.main.get().validate("Bukkit plugin main class name", "^(?!org\\.bukkit\\.)([a-zA-Z_$][a-zA-Z\\d_$]*\\.)*[a-zA-Z_$][a-zA-Z\\d_$]*$")
         val description = yml.description.orNull
         val load = yml.load.orNull
         val author = yml.author.orNull

diff --git a/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/bungee/BungeePluginYml.kt b/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/bungee/BungeePluginYml.kt
@@ -17,6 +17,7 @@ import xyz.jpenilla.resourcefactory.ResourceFactory
 import xyz.jpenilla.resourcefactory.util.ProjectMetaConventions
 import xyz.jpenilla.resourcefactory.util.nullAction
 import xyz.jpenilla.resourcefactory.util.nullIfEmpty
+import xyz.jpenilla.resourcefactory.util.validate
 
 fun Project.bungeePluginYml(configure: Action<BungeePluginYml> = nullAction()): BungeePluginYml {
     val yml = BungeePluginYml(objects)
@@ -74,7 +75,7 @@ class BungeePluginYml constructor(
 
     @ConfigSerializable
     class Serializable(yml: BungeePluginYml) {
-        val name = yml.name.get()
+        val name = yml.name.get().validate("Bungee plugin name", "^[A-Za-z0-9_\\.-]+$")
         val main = yml.main.get()
         val version = yml.version.orNull
         val author = yml.author.orNull

diff --git a/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/paper/PaperPluginYml.kt b/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/paper/PaperPluginYml.kt
@@ -23,6 +23,7 @@ import xyz.jpenilla.resourcefactory.bukkit.Permission
 import xyz.jpenilla.resourcefactory.util.ProjectMetaConventions
 import xyz.jpenilla.resourcefactory.util.nullAction
 import xyz.jpenilla.resourcefactory.util.nullIfEmpty
+import xyz.jpenilla.resourcefactory.util.validate
 import javax.inject.Inject
 
 fun Project.paperPluginYml(configure: Action<PaperPluginYml> = nullAction()): PaperPluginYml {
@@ -177,12 +178,16 @@ class PaperPluginYml constructor(
 
     @ConfigSerializable
     class Serializable(yml: PaperPluginYml) {
+        companion object {
+            private const val PLUGIN_CLASS_PATTERN: String = "^(?!io\\.papermc\\.)([a-zA-Z_$][a-zA-Z\\d_$]*\\.)*[a-zA-Z_$][a-zA-Z\\d_$]*$"
+        }
+
         val apiVersion = yml.apiVersion.get()
-        val name = yml.name.get()
+        val name = yml.name.get().validate("Paper plugin name", "^[A-Za-z0-9_\\.-]+$")
         val version = yml.version.get()
-        val main = yml.main.get()
-        val loader = yml.loader.orNull
-        val bootstrapper = yml.bootstrapper.orNull
+        val main = yml.main.get().validate("Paper plugin main class name", PLUGIN_CLASS_PATTERN)
+        val loader = yml.loader.orNull?.validate("Paper plugin loader class name", PLUGIN_CLASS_PATTERN)
+        val bootstrapper = yml.bootstrapper.orNull?.validate("Paper plugin bootstrapper class name", PLUGIN_CLASS_PATTERN)
         val description = yml.description.orNull
         val author = yml.author.orNull
         val authors = yml.authors.nullIfEmpty()

diff --git a/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/util/ext.kt b/plugin/src/main/kotlin/xyz/jpenilla/resourcefactory/util/ext.kt
@@ -1,9 +1,11 @@
 package xyz.jpenilla.resourcefactory.util
 
+import org.gradle.api.GradleException
 import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.SetProperty
+import java.util.regex.Pattern
 
 fun <T> ListProperty<T>.nullIfEmpty(): List<T>? = if (get().isEmpty()) null else get().toList()
 
@@ -12,3 +14,11 @@ fun <T> SetProperty<T>.nullIfEmpty(): Set<T>? = if (get().isEmpty()) null else g
 fun <A, B> MapProperty<A, B>.nullIfEmpty(): Map<A, B>? = if (get().isEmpty()) null else get().toMap()
 
 fun <A> NamedDomainObjectContainer<A>.nullIfEmpty(): Map<String, A>? = if (isEmpty()) null else asMap.toMap()
+
+fun String.validate(thing: String, pattern: String): String {
+    val regex = Pattern.compile(pattern)
+    if (!regex.matcher(this).matches()) {
+        throw GradleException("Invalid $thing '$this', must match pattern '$pattern'.")
+    }
+    return this
+}