GitOps - added path validator and GitOps documentation

Author: petruki

src/app/dashboard-module/domain-module/ext-gitops/ext-gitops.component.ts

@@ -12,7 +12,7 @@ import { GitOpsEnvSelectionComponent } from './gitops-env-selection/gitops-env-s
 import { FormBuilder, FormControl, FormGroup, Validators } from '@angular/forms';
 import { AdminService } from 'src/app/services/admin.service';
 import { GitOpsUpdateTokensComponent } from './gitops-update-tokens/gitops-update-tokens.component';
-import { windowValidator } from './gitops-validator';
+import { pathValidator, windowValidator } from './gitops-validator';
 import { ToastService } from 'src/app/_helpers/toast.service';
 import { NgbModal } from '@ng-bootstrap/ng-bootstrap';
 import { NgbdModalConfirmComponent } from 'src/app/_helpers/confirmation-dialog';
@@ -268,7 +268,7 @@ export class ExtGitOpsComponent implements OnInit, OnDestroy {
       environment: new FormControl('', [Validators.required]),
       repository: new FormControl('', [Validators.required]),
       branch: new FormControl('', [Validators.required]),
-      path: new FormControl(''),
+      path: new FormControl('', [pathValidator(), Validators.maxLength(255)]),
       token: new FormControl('', [Validators.required]),
       active: new FormControl(true),
       forceprune: new FormControl(false),

src/app/dashboard-module/domain-module/ext-gitops/gitops-validator.ts

@@ -1,6 +1,9 @@
 import { ValidatorFn } from '@angular/forms';
 
+// Allow only values like 1s, 1m, 1h
 const regex = new RegExp(/^\d+[smh]$/);
+// Allow slash, alphanumeric, hyphen, underscore, dot only
+const regexPath = new RegExp(/^[a-zA-Z0-9/_\-.]+$/);
 
 /**
  * Allows only values
@@ -22,4 +25,20 @@ export function windowValidator(): ValidatorFn {
       return { invalidWindow: true };
     }
   };
+}
+
+export function pathValidator(): ValidatorFn {
+  return control => {
+    const value = control.value as string;
+    
+    if (value.length > 0) {
+      if (value.startsWith('/') || value.endsWith('/') || value.includes('//')) {
+        return { invalidPath: true };
+      }
+
+      if (!regexPath.test(value)) {
+        return { invalidPath: true };
+      }
+    }
+  };
 }

src/app/documentation-module/docs/api.component.ts

@@ -15,7 +15,7 @@ import { MarkdownService } from 'ngx-markdown';
 })
 export class ApiComponent extends MarkdownInjector {
 
-  constructor(private markdownComponentService: MarkdownService) {
+  constructor(private readonly markdownComponentService: MarkdownService) {
     super(markdownComponentService, 'documentation/api.md');
   }
 

src/app/documentation-module/docs/components.component.ts

@@ -15,7 +15,7 @@ import { MarkdownInjector } from './markdown-injector.component';
 })
 export class ComponentsComponent extends MarkdownInjector {
 
-  constructor(private markdownComponentService: MarkdownService) {
+  constructor(private readonly markdownComponentService: MarkdownService) {
     super(markdownComponentService, 'documentation/components.md');
   }
 

src/app/documentation-module/docs/environment.component.ts

@@ -15,7 +15,7 @@ import { MarkdownService } from 'ngx-markdown';
 })
 export class EnvironmentComponent extends MarkdownInjector {
 
-  constructor(private markdownComponentService: MarkdownService) {
+  constructor(private readonly markdownComponentService: MarkdownService) {
     super(markdownComponentService, 'documentation/environment.md');
   }
 

src/app/documentation-module/docs/gitops.component.ts

@@ -0,0 +1,22 @@
+import { Component } from '@angular/core';
+import { MarkdownInjector } from './markdown-injector.component';
+import { MarkdownService } from 'ngx-markdown';
+
+@Component({
+  selector: 'app-home',
+  template: `
+    <div class="doc-header">
+      <h3 class="doc-title">Switcher GitOps</h3>
+      <img src="assets/switcherapi_mark_white.png" class="doc-icon" alt="Switcher API">
+    </div>
+    <markdown [data]="markdown"></markdown>
+  `,
+  styleUrls: ['../documentation/documentation.component.css']
+})
+export class GitOpsDocsComponent extends MarkdownInjector {
+
+  constructor(private readonly markdownComponentService: MarkdownService) {
+    super(markdownComponentService, 'documentation/gitops.md');
+  }
+
+}

src/app/documentation-module/docs/home.component.ts

@@ -15,7 +15,7 @@ import { MarkdownService } from 'ngx-markdown';
 })
 export class HomeComponent extends MarkdownInjector {
 
-  constructor(private markdownComponentService: MarkdownService) {
+  constructor(private readonly markdownComponentService: MarkdownService) {
     super(markdownComponentService, 'documentation/overview.md');
   }
 

src/app/documentation-module/docs/lib-java.component.ts

@@ -15,7 +15,7 @@ import { MarkdownService } from 'ngx-markdown';
 })
 export class LibJavaComponent extends MarkdownInjector {
 
-  constructor(private markdownComponentService: MarkdownService) {
+  constructor(private readonly markdownComponentService: MarkdownService) {
     super(markdownComponentService, 'documentation/libjava.md');
   }
 

src/app/documentation-module/docs/lib-javascript.component.ts

@@ -15,7 +15,7 @@ import { MarkdownService } from 'ngx-markdown';
 })
 export class LibJavaScriptComponent extends MarkdownInjector {
 
-  constructor(private markdownComponentService: MarkdownService) {
+  constructor(private readonly markdownComponentService: MarkdownService) {
     super(markdownComponentService, 'documentation/libjavascript.md');
   }
 

src/app/documentation-module/docs/metrics.component.ts

@@ -15,7 +15,7 @@ import { MarkdownService } from 'ngx-markdown';
 })
 export class MetricsComponent extends MarkdownInjector {
 
-  constructor(private markdownComponentService: MarkdownService) {
+  constructor(private readonly markdownComponentService: MarkdownService) {
     super(markdownComponentService, 'documentation/metrics.md');
   }