feat: Refactor PostHero method for improved error handling and add ne…

…w test style documentation 🚀
0GiS0 · Dec 30, 2024 · 95be31c · 95be31c
1 parent 7639f7f
commit 95be31c
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 21 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -5,7 +5,7 @@
       "text": "Always add a comment: 'This code was generated by GitHub Copilot 🤖'"
     },
     {
-      "file": "docs/code-style.md"
+      "file": "docs/copilot/code-style.md"
     }
   ],
   "github.copilot.chat.commitMessageGeneration.instructions": [
@@ -19,15 +19,21 @@
       "text": "Add emoji at the end of the message."
     },
     {
-      "file": "docs/commit-style.md"
+      "file": "docs/copilot/commit-style.md"
     }
   ],
   "github.copilot.chat.testGeneration.instructions": [
     {
-      "text": "Always add a comment: 'This test was generated by GitHub Copilot 🤖'"
+      "text": "Indicate the test type in the comment."
+    },
+    {
+      "text": "Always add a comment at every method: 'This test was generated by GitHub Copilot 🤖'"
     },
     {
       "text": "Use the same name as the function being tested."
+    },
+    {
+      "file": "docs/copilot/test-style.md"
     }
   ],
   "github.copilot.chat.reviewSelection.enabled": true,

diff --git a/docs/code-style.md → docs/copilot/code-style.md b/docs/code-style.md → docs/copilot/code-style.md
diff --git a/docs/commit-style.md → docs/copilot/commit-style.md b/docs/commit-style.md → docs/copilot/commit-style.md
diff --git a/docs/copilot/test-style.md b/docs/copilot/test-style.md
@@ -0,0 +1,4 @@
+## Tests required
+If the user asks for tests to be generated, the following tests should be generated:
+- Test for the happy path
+- Test for the sad path
diff --git a/src/Controllers/HeroController.cs b/src/Controllers/HeroController.cs
@@ -1,8 +1,5 @@
-using System.Collections.Generic;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc;
 using tour_of_heroes_api.Models;
-using System.Linq;
 
 namespace tour_of_heroes_api.Controllers
 {
@@ -67,21 +64,8 @@ public ActionResult PutHero(int id, Hero hero)
         [HttpPost]
         public ActionResult<Hero> PostHero(Hero hero)
         {
-            if (hero == null)
-            {
-                return BadRequest("Hero cannot be null.");
-            }
-
-            try
-            {
-                _heroRepository.Add(hero);
-                return CreatedAtAction(nameof(GetHero), new { id = hero.Id }, hero);
-            }
-            catch (Exception ex)
-            {
-                // Log the exception (ex) here if necessary
-                return StatusCode(500, "Internal server error");
-            }
+            _heroRepository.Add(hero);
+            return Ok(hero);
         }
 
         // DELETE: api/Hero/5