feat: add e2e example tests for cli

Signed-off-by: peefy <xpf6677@163.com>

Author: Peefy

.github/workflows/cla.yml renamed to .github/workflows/cla.yaml

@@ -0,0 +1,23 @@
+name: example-e2e-test
+on:
+  pull_request:
+    branches:
+     - main
+  push:
+    branches:
+     - main
+jobs:
+  example-e2e-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v1
+        with:
+          go-version: "1.19"
+
+      - name: kcl Installation
+        run: go install ./cmd/kcl
+
+      - name: Example tests
+        shell: bash -ieo pipefail {0}
+        run: PATH=$PATH:$HOME/go/bin ./examples/test.sh

.github/workflows/example-e2e-tests.yaml

@@ -24,6 +24,8 @@ dist
 go.work
 # Go coverage test
 coverage.out
+.terraform
+.terraform.lock.hcl
 
 build/
 .vscode/

.github/workflows/release.yml renamed to .github/workflows/release.yaml

@@ -0,0 +1,3 @@
+# Examples
+
+This folder contains a collection of KCL examples:

.gitignore

@@ -0,0 +1,9 @@
+docker:
+	kcl main.k docker_compose_render.k
+
+k8s:
+	kcl main.k kubernetes_render.k
+
+test:
+	make docker
+	make k8s

examples/README.md

@@ -0,0 +1,51 @@
+schema App:
+    """The application model."""
+    name: str
+    replicas: int = 1
+    labels?: {str:str} = {app = name}
+    service?: Service
+    containers?: {str: Container}
+
+schema Service:
+    """The service model."""
+    $type?: str
+    ports: [Port]
+
+schema Port:
+    """The port model."""
+    port: int
+    protocol: "TCP" | "UDP" | "SCTP" = "TCP"
+    targetPort?: int | str
+
+schema Container:
+    """The container model."""
+    image: str
+    command?: [str]
+    args?: [str]
+    env?: [Env]
+    volumes?: [Volume]
+    resources?: Resource
+    ports: [ContainerPort]
+
+schema ContainerPort:
+    """The container port model."""
+    name?: str
+    protocol: "TCP" | "UDP" | "SCTP" = "TCP"
+    containerPort: int
+
+    check:
+        1 <= containerPort <= 65535, "containerPort must be between 1 and 65535, inclusive"
+
+schema Env:
+    name: str
+    value: str
+
+schema Volume:
+    source: str
+    path: str
+    target: str
+    readOnly?: bool = False
+
+schema Resource:
+    limits?: {str:}
+    requests?: {str:}

examples/abstraction/Makefile

@@ -0,0 +1,29 @@
+import manifests
+
+import .app
+
+# Convert the `App` model into the docker compose config.
+dockerComposeRender = lambda a: app.App {
+    # NOTE: Only one container per workload can be defined for compose.
+    #       All other containers will be ignored by this tool.
+    c: app.Container = [c for _, c in a.containers][0] if a.containers else {}
+    # Construct the docker compose config.
+    [{
+        services = {
+            "${a.name}" = {
+                image = c.image
+                entrypoint = c.command
+                environment = c.env
+                volumes = c.volumes
+                ports = [{
+                    published = p.port
+                    target = p.targetPort or p.port
+                    protocol = p.protocol
+                } for p in a.service?.ports]
+            }
+        }
+    }]
+}
+
+# Process multiple app instances and output them as docker config
+manifests.yaml_stream(sum([dockerComposeRender(a) for a in app.App.instances()], []))

examples/abstraction/app.k

@@ -0,0 +1,2 @@
+[package]
+

examples/abstraction/docker_compose_render.k

@@ -0,0 +1,47 @@
+import manifests
+
+import .app
+
+# Convert the `App` model into Kubernetes Deployment and Service Manifests
+kubernetesRender = lambda a: app.App {
+    # Construct the deployment manifest.
+    deployment = {
+        apiVersion = "apps/v1"
+        kind = "Deployment"
+        metadata.name = a.name
+        metadata.labels = a.labels
+        spec = {
+            replicas = a.replicas
+            selector.matchLabels = a.labels
+            template.metadata.labels = a.labels
+            template.spec.containers = [
+                {
+                    name = name
+                    image = c.image
+                    command = c.command
+                    args = c.args
+                    env = c.env
+                    volumeMounts = c.volumes
+                    resources: c.resources
+                    ports = c.ports
+                } for name, c in a.containers
+            ]
+        }
+    }
+    # Construct the service manifest.
+    service = {
+        apiVersion = "v1"
+        kind = "Service"
+        metadata.name = a.name
+        metadata.labels = a.labels
+        spec = {
+            type = a.service?.$type
+            selector = a.labels
+            ports = a.service?.ports
+        }
+    }
+    # Returns Kubernetes manifests
+    [deployment, if a.service: service]
+}
+
+manifests.yaml_stream(sum([kubernetesRender(a) for a in app.App.instances()], []))

examples/abstraction/kcl.mod

@@ -0,0 +1,10 @@
+import .app
+
+app.App {
+    name = "app"
+    containers.ngnix = {
+        image = "ngnix"
+        ports = [{containerPort = 80}]
+    }
+    service.ports = [{ port = 80 }]
+}

examples/abstraction/kcl.mod.lock

@@ -0,0 +1,9 @@
+update:
+	kcl main.k -O app.name='new_app'
+
+delete:
+	kcl main.k -O app.labels.key-
+
+test:
+	make update
+	make delete

examples/abstraction/kubernetes_render.k

@@ -0,0 +1,11 @@
+schema App:
+    """The application model."""
+    name: str
+    replicas: int
+    labels?: {str:str} = {app = name}
+
+app: App {
+    name = "app"
+    replicas = 1
+    labels.key = "value"
+}

examples/abstraction/main.k

@@ -0,0 +1,53 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      
+      - name: Docker Login
+        uses: docker/login-action@v1.10.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          logout: true
+
+      # Runs a set of commands using the runners shell
+      - name: build image
+        run: |
+          make image
+          docker tag flask_demo:latest ${{ secrets.DOCKER_USERNAME }}/flask_demo:${{ github.sha }}
+          docker push ${{ secrets.DOCKER_USERNAME }}/flask_demo:${{ github.sha }}
+
+      - name: Trigger CI
+        uses: InformaticsMatters/trigger-ci-action@1.0.1
+        with:
+          ci-owner: kcl-lang
+          ci-repository: flask-demo-kcl-manifests
+          ci-ref: refs/heads/main
+          ci-user: peefy
+          ci-user-token: ${{ secrets.DEPLOY_ACCESS_TOKEN }}
+          ci-name: CI
+          ci-inputs: >-
+            image=${{ secrets.DOCKER_USERNAME }}/flask_demo
+            sha-tag=${{ github.sha }}

examples/automation/Makefile

@@ -0,0 +1,31 @@
+name: CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+    inputs:
+      image:
+        required: true
+        description: 'docker image name'
+      sha-tag:
+        required: true
+        description: 'docker image tag'
+jobs:
+  update-manifests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        if: ${{ github.event.inputs.image }}
+      - name: KCL config edit
+        if: ${{ github.event.inputs.image }}
+        run: |
+          wget -q https://kcl-lang.io/script/install.sh -O - | /bin/bash
+          /usr/local/kclvm/bin/kcl -d -O config.containers.flask_demo.image="${{ github.event.inputs.image }}:${{ github.event.inputs.sha-tag }}"
+      - name: Git Commit/Push Changes
+        uses: EndBug/add-and-commit@v9
+        if: ${{ github.event.inputs.image }}
+        with:
+          default_author: github_actions
+          message: "kcl code set image to ${{ github.event.inputs.image }}:${{ github.event.inputs.sha-tag }}"

examples/automation/main.k

@@ -0,0 +1,4 @@
+test:
+	make -C simple
+	make -C schema
+	make -C collaborative

examples/ci-integration/github-actions/app.yaml

@@ -0,0 +1,14 @@
+import pkg
+
+server: pkg.Server {
+    # Set the image with the value "nginx:1.14.2"
+    image = "nginx:1.14.2"
+    # Add a label app into labels
+    labels.app = "test_app"
+    # Add a mainContainer config, and its ports are [{protocol = "HTTP", port = 80, targetPort = 1100}]
+    mainContainer.ports = [{
+        protocol = "HTTP"
+        port = 80
+        targetPort = 1100
+    }]
+}

examples/ci-integration/github-actions/manifests.yaml

@@ -0,0 +1,19 @@
+server:
+  replicas: 1
+  image: nginx:1.14.2-dev
+  resource:
+    cpu: 1
+    memory: 1073741824
+    disk: 10737418240
+  mainContainer:
+    name: main
+    ports:
+    - protocol: HTTP
+      port: 80
+      targetPort: 1100
+    - protocol: TCP
+      port: 443
+      targetPort: 1100
+  labels:
+    app: test_app
+    env: dev

examples/codelab/Makefile

@@ -0,0 +1,5 @@
+kcl_cli_configs:
+  files:
+    - ../base/base.k
+    - main.k
+  output: ./ci-test/stdout.golden.yaml

examples/codelab/collaborative/appops/test_app/base/base.k

@@ -0,0 +1,14 @@
+import pkg
+
+server: pkg.Server {
+    # Override the base image.
+    image = "nginx:1.14.2-dev"
+    # Union a new label env into base labels.
+    labels.env = "dev"
+    # Append a port into base ports.
+    mainContainer.ports += [{
+        protocol = "TCP"
+        port = 443
+        targetPort = 1100
+    }]
+}

examples/codelab/collaborative/appops/test_app/dev/ci-test/stdout.golden.yaml

@@ -0,0 +1,16 @@
+server:
+  replicas: 1
+  image: nginx:1.14.2
+  resource:
+    cpu: 1
+    memory: 1073741824
+    disk: 10737418240
+  mainContainer:
+    name: main
+    ports:
+    - protocol: HTTP
+      port: 80
+      targetPort: 1100
+  labels:
+    app: test_app
+    env: prod

examples/codelab/collaborative/appops/test_app/dev/kcl.yaml

@@ -0,0 +1,5 @@
+kcl_cli_configs:
+  files:
+    - ../base/base.k
+    - main.k
+  output: ./ci-test/stdout.golden.yaml

examples/codelab/collaborative/appops/test_app/dev/main.k

@@ -0,0 +1,6 @@
+import pkg
+
+server: pkg.Server {
+    # Union a new label env into base labels
+    labels.env = "prod"
+}

examples/codelab/collaborative/appops/test_app/prod/ci-test/stdout.golden.yaml

@@ -0,0 +1,2 @@
+[package]
+