Javadocs and default char for safeVariableName

Author: Pgarrett

core/src/main/kotlin/org/evomaster/core/llm/Prompts.kt

@@ -99,6 +99,15 @@ object Prompts {
         return Pair(VALUE_BASED_ON_NAME_FAILURE, error)
     }
 
+    /**
+     * Used for prompting an LLM to return a new test case name
+     * @param targetLanguage the target language of the test case, used by the LLM to return a name following naming conventions of the language
+     * @param remainingNameChars the maximum amount of chars the returned test case name should have
+     * @param generatedNames set of already returned names from the LLM to avoid duplication of names
+     * @param testLines test case content to feed the LLM context for generating a test case name
+     *
+     * @return [Pair] containing the system prompt with all the scaffolding and rules as first and the user message with the current test information as second.
+     */
     fun getPromptForTestCaseName(targetLanguage: String, remainingNameChars: Int, generatedNames: MutableSet<String>, testLines: String): Pair<String,String>{
         val userMessage = """Your input is
             [targetLanguage]:$targetLanguage"

core/src/main/kotlin/org/evomaster/core/output/TestWriterUtils.kt

@@ -127,11 +127,11 @@ object TestWriterUtils {
 
     /**
      * Some character shouldn't be used for variable names, as it would lead to compilation/runtime errors.
-     * Those are replaced with safe ones
+     * Those are replaced with [replacementChar], which by default is '_'.
      */
-    fun safeVariableName(name: String): String {
+    fun safeVariableName(name: String, replacementChar: String = "_"): String {
 
-        val safe = name.replace(Regex("[^0-9a-zA-Z_]"), "_")
+        val safe = name.replace(Regex("[^0-9a-zA-Z_]"), replacementChar)
         val first = safe.codePointAt(0)
         if(first >= '0'.code && first <= '9'.code ) {
             //can't start a variable name with a number

core/src/main/kotlin/org/evomaster/core/output/naming/LlmServiceTestCaseNamingStrategy.kt

@@ -45,14 +45,9 @@ class LlmServiceTestCaseNamingStrategy(
         return newName
     }
 
-    // LLM is sometimes returning names as "\n\ntheNewName" so we need to fix that.
-    // Also, some tests were ending as "200__" so we remove any trailing underscores.
+    // LLM is sometimes returning names as "\n\ntheNewName_" so we need to fix that and return "theNewName".
     private fun sanitizeName(testName: String): String {
-        var safeName = TestWriterUtils.safeVariableName(testName.trim().replace("\n", ""))
-        while (safeName.endsWith("_")) {
-            safeName = safeName.substringBeforeLast("_")
-        }
-        return safeName
+        return TestWriterUtils.safeVariableName(testName.trim().replace("\n", ""), "")
     }
 
     private fun getNewName(test: TestCase): String {