-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add golang-based transformer for PHP (#575)
Signed-off-by: Akash Nayak <[email protected]>
- Loading branch information
1 parent
cc44205
commit f22dd84
Showing
12 changed files
with
314 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,7 @@ | ||
| apiVersion: move2kube.konveyor.io/v1alpha1 | ||
| kind: Transformer | ||
| metadata: | ||
| name: PHP | ||
| name: PHP-Dockerfile | ||
| spec: | ||
| mode: "Container" | ||
| class: "Executable" | ||
| config: | ||
| directoryDetectCMD: ["./m2kdetect.sh"] | ||
| platforms: ["linux", "darwin"] | ||
| class: "PHPDockerfileGenerator" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
250 changes: 250 additions & 0 deletions
250
internal/transformer/classes/generators/dockerfilegenerators/phpdockerfilegenerator.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,250 @@ | ||
| /* | ||
| * Copyright IBM Corporation 2021 | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package dockerfilegenerators | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| gopache "github.com/Akash-Nayak/GopacheConfig" | ||
| "github.com/konveyor/move2kube/environment" | ||
| "github.com/konveyor/move2kube/internal/common" | ||
| "github.com/konveyor/move2kube/qaengine" | ||
| "github.com/konveyor/move2kube/types/qaengine/commonqa" | ||
| transformertypes "github.com/konveyor/move2kube/types/transformer" | ||
| "github.com/konveyor/move2kube/types/transformer/artifacts" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| const ( | ||
| phpExt = ".php" | ||
| virtualHost = "VirtualHost" | ||
| confExt = ".conf" | ||
| ) | ||
|
|
||
| // PHPDockerfileGenerator implements the Transformer interface | ||
| type PHPDockerfileGenerator struct { | ||
| Config transformertypes.Transformer | ||
| Env *environment.Environment | ||
| } | ||
|
|
||
| // PhpTemplateConfig implements Php config interface | ||
| type PhpTemplateConfig struct { | ||
| ConfFile string | ||
| ConfFilePort int32 | ||
| } | ||
|
|
||
| // Init Initializes the transformer | ||
| func (t *PHPDockerfileGenerator) Init(tc transformertypes.Transformer, env *environment.Environment) (err error) { | ||
| t.Config = tc | ||
| t.Env = env | ||
| return nil | ||
| } | ||
|
|
||
| // GetConfig returns the transformer config | ||
| func (t *PHPDockerfileGenerator) GetConfig() (transformertypes.Transformer, *environment.Environment) { | ||
| return t.Config, t.Env | ||
| } | ||
|
|
||
| // BaseDirectoryDetect runs detect in base directory | ||
| func (t *PHPDockerfileGenerator) BaseDirectoryDetect(dir string) (namedServices map[string]transformertypes.ServicePlan, unnamedServices []transformertypes.TransformerPlan, err error) { | ||
| return nil, nil, nil | ||
| } | ||
|
|
||
| // parseConfFile parses the conf file to detect the port | ||
| func parseConfFile(confFilePath string) (int32, error) { | ||
| var port int32 | ||
| confFile, err := os.Open(confFilePath) | ||
| if err != nil { | ||
| logrus.Errorf("Could not open the apache config file: %s", err) | ||
| return port, err | ||
| } | ||
| defer confFile.Close() | ||
| root, err := gopache.Parse(confFile) | ||
| if err != nil { | ||
| logrus.Errorf("Error while parsing apache config file : %s", err) | ||
| return port, err | ||
| } | ||
| match, err := root.FindOne(virtualHost) | ||
| if err != nil { | ||
| logrus.Debugf("Could not find the VirtualHost in apache config file: %s", err) | ||
| return port, err | ||
| } | ||
| tokens := strings.Split(match.Content, ":") | ||
| if len(tokens) > 1 { | ||
| detectedPort, err := strconv.ParseInt(tokens[1], 10, 32) | ||
| if err != nil { | ||
| logrus.Errorf("Error while converting the port from string to int : %s", err) | ||
| return port, err | ||
| } | ||
| return int32(detectedPort), nil | ||
| } | ||
| return port, err | ||
| } | ||
|
|
||
| // detectConfFiles detects if conf files are present or not | ||
| func detectConfFiles(dir string) ([]string, error) { | ||
| var confFilesPaths []string | ||
| confFiles, err := common.GetFilesByExt(dir, []string{confExt}) | ||
| if err != nil { | ||
| logrus.Debugf("Could not find conf files %s", err) | ||
| return confFilesPaths, err | ||
| } | ||
| for _, confFilePath := range confFiles { | ||
| confFile, err := os.Open(confFilePath) | ||
| if err != nil { | ||
| logrus.Debugf("Could not open the conf file: %s", err) | ||
| confFile.Close() | ||
| continue | ||
| } | ||
| defer confFile.Close() | ||
| _, err = gopache.Parse(confFile) | ||
| if err != nil { | ||
| logrus.Debugf("Error while parsing conf file : %s", err) | ||
| continue | ||
| } | ||
| confFileRelPath, err := filepath.Rel(dir, confFilePath) | ||
| if err != nil { | ||
| logrus.Errorf("Unable to resolve apache config file path %s as rel path : %s", confFilePath, err) | ||
| continue | ||
| } | ||
| confFilesPaths = append(confFilesPaths, confFileRelPath) | ||
| } | ||
| return confFilesPaths, nil | ||
| } | ||
|
|
||
| // GetConfFileForService returns ports used by a service | ||
| func GetConfFileForService(confFiles []string, serviceName string) string { | ||
| noAnswer := "none of the above" | ||
| confFiles = append(confFiles, noAnswer) | ||
| selectedConfFile := qaengine.FetchSelectAnswer(common.ConfigServicesKey+common.Delim+serviceName+common.Delim+common.ConfigApacheConfFileForServiceKeySegment, fmt.Sprintf("Choose the apache config file to be used for the service %s", serviceName), []string{fmt.Sprintf("Selected apache config file will be used for identifying the port to be exposed for the service %s", serviceName)}, confFiles[0], confFiles) | ||
| if selectedConfFile == noAnswer { | ||
| logrus.Debugf("No apache config file selected for the service %s", serviceName) | ||
| return "" | ||
| } | ||
| return selectedConfFile | ||
| } | ||
|
|
||
| // DirectoryDetect runs detect in each sub directory | ||
| func (t *PHPDockerfileGenerator) DirectoryDetect(dir string) (namedServices map[string]transformertypes.ServicePlan, unnamedServices []transformertypes.TransformerPlan, err error) { | ||
| dirEntries, err := os.ReadDir(dir) | ||
| if err != nil { | ||
| logrus.Errorf("Error while trying to read directory : %s", err) | ||
| return nil, nil, err | ||
| } | ||
| for _, de := range dirEntries { | ||
| if de.IsDir() { | ||
| continue | ||
| } | ||
| if filepath.Ext(de.Name()) != phpExt { | ||
| continue | ||
| } | ||
| unnamedServices = []transformertypes.TransformerPlan{{ | ||
| Mode: t.Config.Spec.Mode, | ||
| ArtifactTypes: []transformertypes.ArtifactType{artifacts.ContainerBuildArtifactType}, | ||
| BaseArtifactTypes: []transformertypes.ArtifactType{artifacts.ContainerBuildArtifactType}, | ||
| Paths: map[string][]string{ | ||
| artifacts.ProjectPathPathType: {dir}, | ||
| }, | ||
| }} | ||
| return nil, unnamedServices, nil | ||
| } | ||
| return nil, nil, nil | ||
| } | ||
|
|
||
| // Transform transforms the artifacts | ||
| func (t *PHPDockerfileGenerator) Transform(newArtifacts []transformertypes.Artifact, oldArtifacts []transformertypes.Artifact) ([]transformertypes.PathMapping, []transformertypes.Artifact, error) { | ||
| pathMappings := []transformertypes.PathMapping{} | ||
| artifactsCreated := []transformertypes.Artifact{} | ||
| for _, a := range newArtifacts { | ||
| if a.Artifact != artifacts.ServiceArtifactType { | ||
| continue | ||
| } | ||
| relSrcPath, err := filepath.Rel(t.Env.GetEnvironmentSource(), a.Paths[artifacts.ProjectPathPathType][0]) | ||
| if err != nil { | ||
| logrus.Errorf("Unable to convert source path %s to be relative : %s", a.Paths[artifacts.ProjectPathPathType][0], err) | ||
| } | ||
| var sConfig artifacts.ServiceConfig | ||
| err = a.GetConfig(artifacts.ServiceConfigType, &sConfig) | ||
| if err != nil { | ||
| logrus.Errorf("unable to load config for Transformer into %T : %s", sConfig, err) | ||
| continue | ||
| } | ||
| sImageName := artifacts.ImageName{} | ||
| err = a.GetConfig(artifacts.ImageNameConfigType, &sImageName) | ||
| if err != nil { | ||
| logrus.Debugf("unable to load config for Transformer into %T : %s", sImageName, err) | ||
| } | ||
| var detectedPorts []int32 | ||
| var phpConfig PhpTemplateConfig | ||
| confFiles, err := detectConfFiles(a.Paths[artifacts.ProjectPathPathType][0]) | ||
| if err != nil { | ||
| logrus.Debugf("Could not detect any conf files %s", err) | ||
| } else { | ||
| if len(confFiles) == 1 { | ||
| phpConfig.ConfFile = confFiles[0] | ||
| } else if len(confFiles) > 1 { | ||
| phpConfig.ConfFile = GetConfFileForService(confFiles, a.Name) | ||
| } | ||
| if phpConfig.ConfFile != "" { | ||
| phpConfig.ConfFilePort, err = parseConfFile(filepath.Join(a.Paths[artifacts.ProjectPathPathType][0], phpConfig.ConfFile)) | ||
| if err != nil { | ||
| logrus.Errorf("Error while parsing configuration file : %s", err) | ||
| } | ||
| } | ||
| if phpConfig.ConfFilePort == 0 { | ||
| phpConfig.ConfFilePort = commonqa.GetPortForService(detectedPorts, a.Name) | ||
| } | ||
| } | ||
| if sImageName.ImageName == "" { | ||
| sImageName.ImageName = common.MakeStringContainerImageNameCompliant(sConfig.ServiceName) | ||
| } | ||
| pathMappings = append(pathMappings, transformertypes.PathMapping{ | ||
| Type: transformertypes.SourcePathMappingType, | ||
| DestPath: common.DefaultSourceDir, | ||
| }, transformertypes.PathMapping{ | ||
| Type: transformertypes.TemplatePathMappingType, | ||
| SrcPath: filepath.Join(t.Env.Context, t.Config.Spec.TemplatesDir), | ||
| DestPath: filepath.Join(common.DefaultSourceDir, relSrcPath), | ||
| TemplateConfig: phpConfig, | ||
| }) | ||
| paths := a.Paths | ||
| paths[artifacts.DockerfilePathType] = []string{filepath.Join(common.DefaultSourceDir, relSrcPath, "Dockerfile")} | ||
| p := transformertypes.Artifact{ | ||
| Name: sImageName.ImageName, | ||
| Artifact: artifacts.DockerfileArtifactType, | ||
| Paths: paths, | ||
| Configs: map[string]interface{}{ | ||
| artifacts.ImageNameConfigType: sImageName, | ||
| }, | ||
| } | ||
| dfs := transformertypes.Artifact{ | ||
| Name: sConfig.ServiceName, | ||
| Artifact: artifacts.DockerfileForServiceArtifactType, | ||
| Paths: a.Paths, | ||
| Configs: map[string]interface{}{ | ||
| artifacts.ImageNameConfigType: sImageName, | ||
| artifacts.ServiceConfigType: sConfig, | ||
| }, | ||
| } | ||
| artifactsCreated = append(artifactsCreated, p, dfs) | ||
| } | ||
| return pathMappings, artifactsCreated, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,4 +17,6 @@ | |
|
|
||
| <?php | ||
| echo "<html><body>This is a PHP web app</body></html>"; | ||
|
|
||
| phpinfo(); | ||
| ?> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # site.conf | ||
| ServerName localhost | ||
|
|
||
| Listen 8082 | ||
| <VirtualHost *:8082> | ||
| ServerAdmin webmaster@localhost | ||
| DocumentRoot /var/www/html | ||
|
|
||
| <Directory /var/www/html> | ||
| Options Indexes FollowSymLinks | ||
| AllowOverride All | ||
| Require all granted | ||
| </Directory> | ||
| </VirtualHost> |
Oops, something went wrong.