Merge pull request #2866 from SwiftPackageIndex/extend-tests

Extend tests

Author: daveverwer

Sources/App/Controllers/BlogController.swift

@@ -18,12 +18,11 @@ import Plot
 enum BlogController {
 
     static func index(req: Request) async throws -> HTML {
-        try BlogActions.Index.View(path: req.url.path,
-                                   model: BlogActions.Model()).document()
+        BlogActions.Index.View(path: req.url.path, model: BlogActions.Model()).document()
     }
 
     static func indexFeed(req: Request) async throws -> RSS {
-        let model = try BlogActions.Model()
+        let model = BlogActions.Model()
         let items = model.summaries.map { summary -> Node <RSS.ChannelContext> in
                 .item(
                     .guid(
@@ -59,7 +58,7 @@ enum BlogController {
         guard let slug = req.parameters.get("slug")
         else { throw Abort(.notFound) }
 
-        let model = try BlogActions.Model()
+        let model = BlogActions.Model()
         if let summary = model.summaries.first(where: { $0.slug == slug }) {
             return BlogActions.Show.View(path: req.url.path,
                                          model: summary).document()

Sources/App/Views/Blog/BlogActions+Model.swift

@@ -21,6 +21,10 @@ enum BlogActions {
 
     struct Model {
 
+        static var blogIndexYmlPath: String {
+            Current.fileManager.workingDirectory().appending("Resources/Blog/posts.yml")
+        }
+
         struct PostSummary: Equatable {
             var slug: String
             var title: String
@@ -32,16 +36,8 @@ enum BlogActions {
         var summaries: [PostSummary]
 
         init() {
-            let blogIndexYmlPath = Current.fileManager.workingDirectory()
-                .appending("Resources/Blog/posts.yml")
             do {
-                let allSummaries = if let ymlData = Current.fileManager.contents(atPath: blogIndexYmlPath),
-                    let ymlString = String(data: ymlData, encoding: .utf8) {
-                        // Post order should be as exists in the file, but reversed.
-                        try Array(YAMLDecoder().decode([PostSummary].self, from: ymlString).reversed())
-                    } else {
-                        Array<PostSummary>()
-                    }
+                let allSummaries = try Self.allSummaries()
 
                 summaries = if Current.environment() == .production {
                     // Only "published" posts show in production.
@@ -66,6 +62,17 @@ enum BlogActions {
             latest features, our efforts in the community, and any other updates that affect the site.
             """
         }
+
+        static func allSummaries() throws -> [PostSummary] {
+            guard let data = Current.fileManager.contents(atPath: Self.blogIndexYmlPath) else {
+                throw AppError.genericError(nil, "failed to read posts.yml")
+            }
+
+            // Post order should be as exists in the file, but reversed.
+            return try YAMLDecoder().decode([PostSummary].self, from: String(decoding: data, as: UTF8.self))
+                .reversed()
+        }
+        
     }
 }
 

Tests/AppTests/BlogActionsModelTests.swift

@@ -34,19 +34,37 @@ class BlogActionsModelTests: AppTestCase {
             """.data(using: .utf8)
         }
 
-        // MUT
-        let summaries = try BlogActions.Model().summaries
-
-        XCTAssertEqual(summaries.count, 2)
-        let firstSummary = try XCTUnwrap(summaries).first
-
-        // Note that we are testing that the first item in this list is the *last* item in the source YAML
-        // as the init should reverse the order of posts so that they display in reverse chronological order
-        XCTAssertEqual(firstSummary, BlogActions.Model.PostSummary(slug: "post-2",
-                                                                   title: "Blog post title two",
-                                                                   summary: "Summary of blog post two",
-                                                                   publishedAt: DateFormatter.yearMonthDayDateFormatter.date(from: "2024-01-02")!,
-                                                                   published: false))
+        do { // Ensure dev shows all summaries
+            Current.environment = { .development }
+
+            // MUT
+            let summaries = BlogActions.Model().summaries
+
+            XCTAssertEqual(summaries.count, 2)
+            XCTAssertEqual(summaries.map(\.slug), ["post-2", "post-1"])
+            XCTAssertEqual(summaries.map(\.published), [false, true])
+
+            let firstSummary = try XCTUnwrap(summaries).first
+
+            // Note that we are testing that the first item in this list is the *last* item in the source YAML
+            // as the init should reverse the order of posts so that they display in reverse chronological order
+            XCTAssertEqual(firstSummary, BlogActions.Model.PostSummary(slug: "post-2",
+                                                                       title: "Blog post title two",
+                                                                       summary: "Summary of blog post two",
+                                                                       publishedAt: DateFormatter.yearMonthDayDateFormatter.date(from: "2024-01-02")!,
+                                                                       published: false))
+        }
+
+        do { // Ensure prod shows only published summaries
+            Current.environment = { .production }
+
+            // MUT
+            let summaries = BlogActions.Model().summaries
+
+            // validate
+            XCTAssertEqual(summaries.map(\.slug), ["post-1"])
+            XCTAssertEqual(summaries.map(\.published), [true])
+        }
     }
 
     func test_postSummary_postMarkdown_load() async throws {
@@ -63,4 +81,15 @@ class BlogActionsModelTests: AppTestCase {
         XCTAssertEqual(markdown, "<p>This is some Markdown with <a href=\"https://example.com\">a link</a> and some <em>formatting</em>.</p>")
     }
 
+    func test_decode_posts_yml() async throws {
+        // setup
+        Current.fileManager = .live
+
+        // MUT
+        let summaries = try BlogActions.Model.allSummaries()
+
+        // validate
+        XCTAssert(summaries.count > 0)
+    }
+
 }