Merge pull request #1447 from scm-manager/feature/validate_translation_files

Validate translation files

scm-ui/ui-webapp/translationResources.test.js

@@ -0,0 +1,56 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const fs = require("fs");
+
+const dirs = fs.readdirSync("public/locales");
+
+describe("locales folder", () => {
+  it("should contain folder en", () => {
+    expect(dirs).toContain("en");
+  });
+});
+
+dirs.forEach(languageDirName => {
+  const languageDir = `public/locales/${languageDirName}`;
+  const languageDirFiles = fs.readdirSync(languageDir);
+  languageDirFiles
+    .filter(fileName => fileName.endsWith(".json"))
+    .forEach(translationFileName => {
+      const translationFile = `${languageDir}/${translationFileName}`;
+      describe(`translation file ${translationFile}`, () => {
+        it("should contain only valid json", () => {
+          const jsonContent = fs.readFileSync(translationFile);
+          let json;
+          try {
+            json = JSON.parse(jsonContent);
+          } catch (ex) {
+            // eslint-disable-next-line no-undef
+            fail(new Error(`invalid json: ${ex}`));
+          }
+          expect(json).not.toBe({});
+        });
+      });
+    });
+});

scm-webapp/src/test/java/sonia/scm/web/i18n/I18nServletTest.java

@@ -48,12 +48,15 @@ import java.io.IOException;
 import java.io.PrintWriter;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Enumeration;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.fail;
 import static org.mockito.Mockito.*;
 
 @ExtendWith(MockitoExtension.class)
@@ -239,6 +242,30 @@ class I18nServletTest {
     assertJson(json);
   }
 
+  @Test
+  void shouldNotHaveInvalidPluginsJsonFiles() throws IOException {
+    String path = getClass().getClassLoader().getResource("locales/en/plugins.json").getPath();
+    assertThat(path).isNotNull();
+
+    Path filePath = Paths.get(path);
+    Path translationRootPath = filePath.getParent().getParent();
+    assertThat(translationRootPath).isDirectoryContaining("glob:**/en");
+
+    Files
+      .list(translationRootPath)
+      .filter(Files::isDirectory)
+      .map(localePath -> localePath.resolve("plugins.json"))
+      .forEach(this::validatePluginsJson);
+  }
+
+  private void validatePluginsJson(Path path) {
+    try {
+      new ObjectMapper().readTree(path.toFile());
+    } catch (IOException e) {
+      fail("error while parsing translation file " + path, e);
+    }
+  }
+
   private void verifyHeaders(HttpServletResponse response) {
     verify(response).setCharacterEncoding("UTF-8");
     verify(response).setContentType("application/json");