Merge pull request #38 from dynatrace-wwse/revamp

Revamp

Author: sergiohinojosa

.devcontainer/test/integration.sh

@@ -13,3 +13,5 @@ assertRunningPod dynatrace oneagent
 assertRunningPod todoapp todoapp
 
 assertRunningApp 30100
+
+assertBugsAndRedeployment 

.devcontainer/util/my_functions.sh

@@ -50,6 +50,14 @@ redeployApp(){
 }
 
 
+_check_bug1(){
+
+  addTask '{"title":"Clear completed task","completed":true}'
+  
+  clearCompletedTasks
+
+}
+
 is_bug1_there(){
 
   kubectl logs -l app=todoapp -c todoapp -n todoapp | grep 'completed=true' > /dev/null
@@ -62,16 +70,18 @@ is_bug1_there(){
     printInfo "🪲 Bug 'Clear completed' is there! Thanks for adding tasks and trying to clear them."
     return 0
   else
-    printInfo " ⚠️ Please add a couple of task, mark them completed and then click on the 'clear completed' button in order to see if the 🪲 bug is there..."
+    printWarn " ⚠️ Please add a couple of task, mark them completed and then click on the 'clear completed' button in order to see if the 🪲 bug is there..."
     return 1
   fi
 
 }
 
+
 is_bug1_solved(){
-  addCompletedTask
 
-  clearCompletedTasks
+  printInfoSection "Verifying if the 🪲 Bug 'Clear completed' is gone"
+  
+  _check_bug1
 
   kubectl logs -l app=todoapp -c todoapp -n todoapp | grep 'Removed Todo record.*completed=true' > /dev/null
   found_removed=$?
@@ -80,32 +90,145 @@ is_bug1_solved(){
     printInfo "✅ Bug clear completed is gone."
     return 0
   else
-    printInfo "⚠️ Bug clear completed is still there, tip: check the Arrays"
+    printWarn "⚠️ Bug clear completed is still there, tip: check the Arrays"
     return 1
   fi
 
 }
 
+is_bug2_solved(){
+  printInfoSection "Verifying if the 🪲 Bug 'Special Characters' is gone"
+  RC=0
+
+  addTask '{"title":"Exciting validation!?#","completed":false}'
+
+  printInfo "Retrieving todos to verify the title..."
+  
+  response=$(curl -s -X GET $APPLICATION_URL/todos)
+
+  # Check if special characters are preserved
+  if echo "$response" | grep -q '"title":"Exciting validation!?#"'; then
+    printInfo "✅ Bug special characters is gone. Title preserved correctly."      
+    RC=0
+  elif echo "$response" | grep -q '"title":"Exciting validation"'; then
+    printWarn "⚠️ Bug special characters is still there. Special characters were stripped from the title. Tip: Less is more ;)"
+    RC=1
+  fi
+
+  # Delete taskId
+  #deleteTask $response  
+  return $RC
+}
+
+is_bug3_solved(){
+  printInfoSection "Verifying if the 🪲 Bug 'Duplicate Task' is gone"
+  RC=0
+
+  # Generate a random 6-character ID
+  random_id=$(head /dev/urandom | LC_ALL=C tr -dc 'a-zA-Z0-9' | head -c 6)
+  title="Duplicated task with ID $random_id"
+
+  addTask '{"title":"'"$title"'","completed":false}'
+  
+  response=$(curl -s -X GET $APPLICATION_URL/todos)
+  task_id=$(echo "$response" | grep -o '"title":"'"$title"'","id":"[^"]*"' | grep -o '"id":"[^"]*"' | cut -d'"' -f4)
+
+  if [ -n "$task_id" ]; then
+    printInfo "Duplicating task with ID: $task_id"
+    dup_response=$(curl -s -X POST $APPLICATION_URL/todos/dup/$task_id)
+    
+    if echo "$dup_response" | grep -q '"status":"ok"'; then
+      # Get todos again to verify the duplicate
+      response=$(curl -s -X GET $APPLICATION_URL/todos)
+      
+      # Count how many tasks have the correct title
+      count=$(echo "$response" | grep -o '"title":"'"$title"'"' | wc -l)
+      
+      # Verify original task still exists with the same ID
+      original_exists=$(echo "$response" | grep -q '"title":"'"$title"'","id":"'"$task_id"'"' && echo "yes" || echo "no")
+      
+      # Check if we have 2 tasks with the correct title and the original still exists
+      if [ "$count" -eq 2 ] && [ "$original_exists" = "yes" ]; then
+        printInfo "✅ Bug duplicate task is gone. Found 2 tasks with correct title '$title', including original with ID: $task_id"
+        RC=0
+      else
+        printWarn "⚠️ Bug duplicate task is still there. Expected 2 tasks with title '$title', found: $count. Tip: Check the setter methods in duplicateTodo."
+        RC=1
+      fi
+    else
+      printInfo "❌ Failed to execute duplicate"
+      RC=1
+    fi
+  else
+    printInfo "❌ Could not find the task to duplicate"
+    RC=1
+  fi
+
+  return $RC
+}
+
+deleteTask(){
+  response="$1"
+  # might need it later
+  task_id=$(echo "$response" | grep -o '"title":"Exciting validation[^"]*","id":"[^"]*"' | grep -o '"id":"[^"]*"' | cut -d'"' -f4)
+  if [ -n "$task_id" ]; then
+    printInfo "Deleting task ID: $task_id"
+    delete_response=$(curl -s -X DELETE $APPLICATION_URL/todos/$task_id)
+    if echo "$delete_response" | grep -q '"status":"ok"'; then
+      printInfo "Task deleted successfully"
+    else
+      printInfo "Failed to delete task"
+    fi
+  fi
+}
+
 solve_bug1(){
 
-  printInfoSection "Solving the Bug Clear Completed"
+  printInfoSection "Solving the 🪲 Bug Clear Completed"
+
+  _solve_bug "solution/bug1"
+
+  printInfo "Now add some tasks, mark them completed and click on 'clear completed'"
+  printInfo "You can assert that the bug is gone also by typing 'is_bug1_solved'"
+}
+
+solve_bug2(){
+
+  printInfoSection "Solving the 🪲 Bug Special Characters"
+  _solve_bug "solution/bug2"
+
+  printInfo "Now add some tasks with special characters and see if they are added correctly"
+  printInfo "You can assert that the bug is gone also by typing 'is_bug2_solved'"
+}
+
+solve_bug3(){
+
+  printInfoSection "Solving the 🪲 Bug Duplicated Task"
+  _solve_bug "solution/bug3"
+
+  printInfo "Now duplicate a record and see if the duplicate is correct"
+  printInfo "You can assert that the bug is gone also by typing 'is_bug3_solved'"
+}
+
+_solve_bug(){
+  
+  solution_branch=$1
 
-  printInfo "we change to the branch solution/bug1 where the developer already added the solution for us"
+  printInfo "Changing to the branch $solution_branch where the developer already added the solution for us"
 
-  printInfo "git checkout solution/bug1"
+  printInfo "git checkout $solution_branch"
 
-  git checkout solution/bug1
+  git checkout $solution_branch
 
   printInfo "then we compile the application and redeploy it to the Kubernetes Cluster using the function 'redeployApp'"
 
   redeployApp
 
-  setVersionControl "solution/bug1"
+  setVersionControl "$solution_branch"
 
-  printInfo "Now add some tasks, mark them completed and click on 'clear completed'"
-  printInfo "You can assert that the bug is gone also by typing 'is_bug1_solved'"
 }
 
+
 setVersionControl(){
   printInfo "Setting version control in the DEPLOYMENT_NAME=$DEPLOYMENT_NAME to point to '$1' "
   updateVersionControl "$1" 
@@ -161,13 +284,14 @@ EOF
 }
 
 
-
-# Testing Methods
-
-addCompletedTask(){
-  printInfo "adding completed Task"
+addTask(){
+  jsontask="$1"
+  if [ -z "$jsontask" ]; then
+    jsontask='{"title":"Completed task","completed":true}'
+  fi
+  printInfo "adding task $jsontask"
   response=$(curl -s -X POST $APPLICATION_URL/todos \
-    -H "Content-Type: application/json" -d '{"title":"Completed task","completed":true}')
+    -H "Content-Type: application/json" -d "$jsontask")
 
   if echo "$response" | grep -q '"status":"ok"'; then
     printInfo "✅ Task added successfully"
@@ -186,4 +310,73 @@ clearCompletedTasks(){
     printInfo "❌ Failed to execute Clear completed"
   fi
 
+}
+
+
+
+assertBugsAndRedeployment(){
+  printInfoSection "Verifying if the Bug 1 is there..."
+
+  _check_bug1
+  
+  if is_bug1_solved; then
+    exit 1
+  fi
+
+  printInfo "Bugs are there! now solving 1, 2 and 3 with the TodoController from solution/bug3"
+  
+  replaceTodoController "solution/bug3"
+
+  redeployApp
+
+  waitAppCanHandleRequests
+
+  if ! is_bug1_solved; then
+    exit 1
+  fi
+
+  if ! is_bug2_solved; then
+    exit 1
+  fi
+
+  if ! is_bug3_solved; then
+    exit 1
+  fi
+
+}
+
+replaceTodoController(){
+
+  solution_branch="$1"
+
+  printInfoSection "Replacing the TodoController from branch $solution_branch"
+  
+  if [ -z "$solution_branch" ]; then
+    printError "No solution branch specified"
+    return 1
+  fi
+
+  printInfo "Downloading TodoController.java from $solution_branch branch"
+  
+  curl -s -o app/src/main/java/com/dynatrace/todoapp/TodoController.java \
+    "https://raw.githubusercontent.com/dynatrace-wwse/enablement-live-debugger-bug-hunting/refs/heads/$solution_branch/app/src/main/java/com/dynatrace/todoapp/TodoController.java"
+  
+  if [ $? -eq 0 ]; then
+    printInfo "✅ TodoController.java downloaded successfully from $solution_branch"
+  else
+    printError "❌ Failed to download TodoController.java from $solution_branch"
+    return 1
+  fi
+
+}
+
+assertBug2isThere(){
+  printInfoSection "Verifying if the Bug 2 is there..."
+  
+  is_bug2_solved
+  
+  if ! is_bug1_solved; then
+    exit 1
+  fi
+
 }

docs/1-bug-hunt-via-k8s.md

@@ -143,22 +143,24 @@ is_bug1_solved
     <summary>🛠️ The code changes </summary>
 
 
-    The `TodoController.clearCompletedTodos` changes from trying to remove items from a newly created List, logging an obvious error...
+    The `TodoController.clearCompletedTodos` you just need to change one variable, replace `todoStore` to `todos` in the if clause on line 81.
 
     ```javascript
        
                 if (todosStore.remove(todoRecord)) {
                
     ```
 
-    to removing the correct item and validating the size of the array after the changes with the correct logging message.
+    this way when iterating in the `todos` array, when the `todoRecord.isCompleted()` then we remove it from the correct list.
 
     ```javascript
       
                 if (todos.remove(todoRecord)) {
             
-
     ```
+    When the removal succeeds, then the correct log record will be printed out.
+
+
     </details>
 
 
@@ -167,7 +169,8 @@ is_bug1_solved
         More on this in the section "Version Control" of this tutorial.
 
 
-    Verify the bug is gone! add more tasks and click on `clear completed` see how the tasks disappear gracefully now! Amazing!
+
+Verify the bug is gone! add more tasks and click on `clear completed` see how the tasks disappear gracefully now! Amazing!
 
 
 <div class="grid cards" markdown>