[Readme]Add message for readme during validation (#8608)

* add message for readme during validation & unit test
NuGet · Jun 8, 2021 · 17d0302 · 17d0302
1 parent 820656c
commit 17d0302
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 0 deletions.
diff --git a/src/NuGetGallery/Helpers/ViewModelExtensions/DisplayPackageViewModelFactory.cs b/src/NuGetGallery/Helpers/ViewModelExtensions/DisplayPackageViewModelFactory.cs
@@ -135,6 +135,7 @@ private DisplayPackageViewModel SetupInternal(
             viewModel.ReadMeImagesRewritten = readmeResult != null ? readmeResult.ImagesRewritten : false;
             viewModel.ReadmeImageSourceDisallowed = readmeResult != null ? readmeResult.ImageSourceDisallowed : false;
             viewModel.HasEmbeddedIcon = package.HasEmbeddedIcon;
+            viewModel.HasEmbeddedReadmeFile = package.HasEmbeddedReadme;
 
             return viewModel;
         }

diff --git a/src/NuGetGallery/Views/Packages/DisplayPackage.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackage.cshtml
@@ -290,6 +290,15 @@
                     )
                 }
 
+                if (Model.HasEmbeddedReadmeFile)
+                {
+                    @ViewHelpers.AlertWarning(
+                        @<text>
+                            The readme will become available once package validation has completed successfully.
+                        </text>
+                    )
+                }
+
                 if (Model.ValidatingTooLong)
                 {
                     @ViewHelpers.AlertWarning(

diff --git a/tests/NuGetGallery.Facts/ViewModels/DisplayPackageViewModelFacts.cs b/tests/NuGetGallery.Facts/ViewModels/DisplayPackageViewModelFacts.cs
@@ -570,6 +570,58 @@ public void HasNewerReleaseDoesNotConsiderUnlistedVersions()
             Assert.False(hasNewerRelease);
         }
 
+        [Fact]
+        public void HasEmbeddedReadmeFileTrueIfPackageHasEmbeddedReadme()
+        {
+            var package = new Package
+            {
+                Key = 123,
+                Version = "1.0.0",
+                HasReadMe = true,
+                EmbeddedReadmeType = EmbeddedReadmeFileType.Markdown,
+                PackageRegistration = new PackageRegistration
+                {
+                    Owners = Enumerable.Empty<User>().ToList(),
+                }
+            };
+
+            package.PackageRegistration.Packages = new[] { package };
+
+            var viewModel = CreateDisplayPackageViewModel(package, currentUser: null, packageKeyToDeprecation: null, readmeHtml: null);
+
+            //Act
+            var hasEmbeddedReadmeFile = viewModel.HasEmbeddedReadmeFile;
+
+            //Assert
+            Assert.True(hasEmbeddedReadmeFile);
+        }
+
+        [Fact]
+        public void HasEmbeddedReadmeFileFalseIfPackageHasLegacyReadme()
+        {
+            var package = new Package
+            {
+                Key = 123,
+                Version = "1.0.0",
+                HasReadMe = true,
+                EmbeddedReadmeType = EmbeddedReadmeFileType.Absent,
+                PackageRegistration = new PackageRegistration
+                {
+                    Owners = Enumerable.Empty<User>().ToList(),
+                }
+            };
+
+            package.PackageRegistration.Packages = new[] { package };
+
+            var viewModel = CreateDisplayPackageViewModel(package, currentUser: null, packageKeyToDeprecation: null, readmeHtml: null);
+
+            //Act
+            var hasEmbeddedReadmeFile = viewModel.HasEmbeddedReadmeFile;
+
+            //Assert
+            Assert.False(hasEmbeddedReadmeFile);
+        }
+
         private Package CreateTestPackage(string version, string dependencyVersion = null)
         {
             var package = new Package