feat: Implement first phase of move2kube workflow

[eloycoto]

This commit adds the first phase of the move2kube workflow example. A user give any git repo, and it'll will be transformed using move2kube, two new folders will be commited (deploy and scripts) inside the repository where the transformed application can be used.

This PR introduces a new 3party dependency that it's the openapi client from move2kube.

The workflow is the following one:

sequenceDiagram
    participant User
    participant Parodos
    participant API as Move2Kube API
    participant web as Move2kube Web
    participant k8s as OpenshiftCluster

    rect rgb(221, 255, 221)
    User ->> Parodos: Enter params
    Note over User,Parodos: Parameters needed:<br/>- Git Repo<br/>- Git Credentials<br/>- GitTargetBranch<br/>- Profile as workspaceID?
    end

    rect rgb(221, 255, 221)
    Parodos ->> API: Get Workspace
    API ->> Parodos: return workspace ID
    Parodos ->> API: Post Project (Workflow ID as project ID)
    API ->> Parodos: Return project ID
    end

    Note over Parodos,API: Here Parodos prepare the plan
    rect rgb(221, 255, 221)
    Parodos --> Parodos: Git Clone
    Parodos --> Parodos: Git archive
    end

    rect rgb(221, 255, 221)
    Parodos --> API: Push ZIP file as project input1 POST /workspaces/{workspace-id}/projects/{project-id}/inputs

    Parodos ->> API: POST /workspaces/{workspace-id}/projects/{project-id}/plan
    Parodos ->> API: Get /workspaces/{workspace-id}/projects/{project-id}/plan

    Note over API,User: Here user get notified to start transformation
    Parodos ->> User: Link to project-id move2kube page
    User ->> web: User execute the transformation step in move2kube

    loop Every minute
        Parodos ->> API: Is transformation ready?
    end

    Note over API,User: Trasnformation completed successfully
    Parodos ->> API: Get outputs
    Parodos ->> Parodos: Branch code
    Parodos ->> Parodos: Commit changes

    end

    Parodos ->> Parodos: Push code to the specified branch

    Note over Parodos: Openshift deployment
    Parodos ->> Parodos: Build images for project
    Parodos ->> k8s: Apply all manifests
    Parodos ->> User: Workflow completed successfully with route

Loading

All the green boxes are created, the not-highlight ones are the ones for the next PR.

For move2kube an workspace need to be created, and the config that I used is the following one:

move2kube:
  containerruntime: docker
  minreplicas: "2"
  services:
    demo:
      "8080":
        servicetype: Ingress
        urlpath: /
      enable: true
      port: "8080"
  target:
    default:
      clustertype: Kubernetes
      ingress:
        host: localhost
        ingressclassname: ""
        tls: ""
    imageregistry:
      quay.io:
        logintype: no authentication
      namespace: parodos
      url: quay.com
  transformers:
    types:
      - ArgoCD
      - Buildconfig
      - ClusterSelector
      - ComposeAnalyser
      - ComposeGenerator
      - ContainerImagesPushScriptGenerator
      - DockerfileDetector
      - DockerfileImageBuildScript
      - DockerfileParser
      - DotNetCore-Dockerfile
      - Gradle
      - Jar
      - Jboss
      - Kubernetes
      - KubernetesVersionChanger
      - Liberty
      - Maven
      - Parameterizer
      - ReadMeGenerator
      - Tomcat
      - WarAnalyser
      - WarRouter
      - WinWebApp-Dockerfile
      - ZuulAnalyser
  transformerselector: ""

To run move2kube the easiest way that I find is the following command:

docker run --rm -it -p 8081:8080 quay.io/konveyor/move2kube-ui

Fix: https://issues.redhat.com/browse/FLPATH-356
Partial-Fix: https://issues.redhat.com/browse/FLPATH-355

Demo: https://drive.google.com/file/d/1k9RwRI4PPBwinDWRyARvTsbFGiQD6vjh/view?usp=sharing

[pkliczewski]

I see opportunity to share the code with GitBranchTask. There is good amount of the same code.

[eloycoto]

because the getRepo you mean? It's overwritten after in the workflow examples. the other code I cannot see a room to share the code with

[pkliczewski]

I think we should make it configurable

[pkliczewski]

How much time transformation is taking? Do you think checking it so often make sense?

[eloycoto]

It's a human process, so can take a lot, but for demo purposes is great.

[masayag]

this can be defined only by code? meaning, changing the corn-expression requires releasing a new version of the workflow?

[eloycoto]

yes, is the only way.

[pkliczewski]

Why do we want to wait exponentially here to get the plan? We could try using async instead. Please take a look how @gciavarrini implemented api wait.

[eloycoto]

The thing is that it's not waiting at all. it's returning 404 does not exists.. so we need to wait until the plan is created

[pkliczewski]

That was exactly the reason why Gloria implemented it in this way.

[eloycoto]

ohh, got it. The main problem that I can see, I need to implement the async way for move2kube API for an example workflow, does that make sense?

[pkliczewski]

please create a task to track this change

[RichardW98]

somehow the workflow-examples' test is still reported in coverage, shall we remove it and only runs it in maven build?

[masayag]

There is an API for that: java.nio.file.Files.createTempFile

[eloycoto]

I know, and I do not need to create the file at all, only the path for creating a sample ZIP:

	private static File createSampleZip() throws IOException {
		String zipFileName = "/tmp/test%s.zip".formatted(UUID.randomUUID());
		String tempDir = "/tmp/%s/".formatted(UUID.randomUUID().toString());
		File zipFile = new File(zipFileName);
		String[] fileNames = { "output/project-name/deploy/bar.txt", "output/project-name/deploy/foo.txt",
				"output/project-name/scripts/bar.sh", "output/project-name/scripts/foo.sh" };

		byte[] buffer = new byte[1024];

		FileOutputStream fos = new FileOutputStream(zipFile);
		ZipOutputStream zos = new ZipOutputStream(fos);

		for (String fileName : fileNames) {
			File file = new File("%s%s".formatted(tempDir, fileName));
			if (file.getParentFile() != null && !file.getParentFile().exists()) {
				assertTrue(file.getParentFile().mkdirs());
			}
			assertTrue(file.createNewFile());

			ZipEntry zipEntry = new ZipEntry(fileName);
			zos.putNextEntry(zipEntry);

			FileInputStream fis = new FileInputStream(file);
			int length;
			while ((length = fis.read(buffer)) > 0) {
				zos.write(buffer, 0, length);
			}

			fis.close();
			zos.closeEntry();
		}

		zos.close();
		return zipFile;
	}

[masayag]

1. pls prefer the use of assertThat.
2. The order of parameters counts as it used to generate the error message: assertXYX(expected, actual)

[masayag]

private?

[masayag]

private?

[eloycoto]

70% of coverage already 🎉

@masayag

#375 (comment)

The only thing missing is the getRepo in the GitTask. I would like to keep like
that for the shake of making it clear, but it's up to you

#375 (comment)

This is something that we need to revisit. Are you happy if I create a new task
for this?

Almost all the assertTrue,assertEquals are now in assertThat; maybe one is missing, but I didn't spot it.

@piotr,

Can I merge this and work on the async of the client on a different PR? That will unlock the git push prebuild-task

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RichardW98

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [RichardW98]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[masayag]

/lgtm