You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwhisk.apache.org by mr...@apache.org on 2018/02/12 15:12:28 UTC
[incubator-openwhisk-wskdeploy] branch master updated: Adding
support for export managed project back to manifest (#715)
This is an automated email from the ASF dual-hosted git repository.
mrutkowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-wskdeploy.git
The following commit(s) were added to refs/heads/master by this push:
new dfc38de Adding support for export managed project back to manifest (#715)
dfc38de is described below
commit dfc38de84e2b38e14c7ae89d7dfbd11d47378dbd
Author: kpavel <kp...@il.ibm.com>
AuthorDate: Mon Feb 12 17:12:25 2018 +0200
Adding support for export managed project back to manifest (#715)
* Export functionality command added
to export managed project into manifest file using
`wskdeploy export -p <MANAGED_PROJECT_NAME>`-m <TARGET_MANIFEST_FILENAME>
Project assets will be stored in specified manifest file and all the
actions functions code will be stored in the same directory in respective
files.
All the exported assets (packages/actions...etc) must be managed by same
project via annotations in a regular wskdeploy way.
Currently there may be an issue with multiple managed packages under same
project, as triggers and rules currently placed under packages in the
wskdeploy manifest model, instead of top level similat to OW model
* Bug fix
* Use relative path when store action functions
* Fixed error when rule not exported
added check for a case when rule target action is a sequence
* Fixed gofmt issues
---
cmd/export.go | 280 ++++++++++++++++++++++++++++++++++++++++++++++++++
cmd/root.go | 12 ++-
parsers/yamlparser.go | 57 ++++++++++
utils/runtimes.go | 24 +++++
4 files changed, 368 insertions(+), 5 deletions(-)
diff --git a/cmd/export.go b/cmd/export.go
new file mode 100644
index 0000000..c6ea0e3
--- /dev/null
+++ b/cmd/export.go
@@ -0,0 +1,280 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 cmd
+
+import (
+ "errors"
+ "fmt"
+ "os"
+ "path/filepath"
+ "strings"
+
+ "github.com/apache/incubator-openwhisk-client-go/whisk"
+ "github.com/apache/incubator-openwhisk-wskdeploy/deployers"
+ "github.com/apache/incubator-openwhisk-wskdeploy/parsers"
+ "github.com/apache/incubator-openwhisk-wskdeploy/utils"
+ "github.com/apache/incubator-openwhisk-wskdeploy/wskderrors"
+ "github.com/spf13/cobra"
+)
+
+var exportCmd = &cobra.Command{
+ Use: "export",
+ SuggestFor: []string{"capture"},
+ Short: "Export project assets from OpenWhisk",
+ Long: `Exports managed project assets from OpenWhisk to manifest and function files`,
+ RunE: ExportCmdImp,
+}
+
+var config *whisk.Config
+
+func ExportRule(wskRule whisk.Rule, pkgName string, maniyaml *parsers.YAML) {
+ if maniyaml.Packages[pkgName].Rules == nil {
+ pkg := maniyaml.Packages[pkgName]
+ pkg.Rules = make(map[string]parsers.Rule)
+ maniyaml.Packages[pkgName] = pkg
+ }
+
+ // export rule to manifest
+ maniyaml.Packages[pkgName].Rules[wskRule.Name] = *maniyaml.ComposeParsersRule(wskRule)
+}
+
+func ExportAction(actionName string, packageName string, maniyaml *parsers.YAML) error {
+
+ pkg := maniyaml.Packages[packageName]
+ if pkg.Actions == nil {
+ pkg.Actions = make(map[string]parsers.Action)
+ maniyaml.Packages[packageName] = pkg
+ }
+
+ wskAction, _, err := client.Actions.Get(actionName)
+ if err != nil {
+ return err
+ }
+ if wskAction.Exec.Kind == "sequence" {
+ seq := new(parsers.Sequence)
+ for _, component := range wskAction.Exec.Components {
+ // must ommit namespace from seq component name
+ ExportAction(strings.SplitN(component, "/", 3)[2], packageName, maniyaml)
+ slices := strings.Split(component, "/")
+
+ // save in the seq list only action names
+ if len(seq.Actions) > 0 {
+ seq.Actions += ","
+ }
+
+ seq.Actions += slices[len(slices)-1]
+ }
+
+ pkg = maniyaml.Packages[packageName]
+ if pkg.Sequences == nil {
+ pkg.Sequences = make(map[string]parsers.Sequence)
+ }
+
+ pkg.Sequences[wskAction.Name] = *seq
+ } else {
+ parsedAction := *maniyaml.ComposeParsersAction(*wskAction)
+
+ // get the action file extension according to action kind (e.g. js for nodejs)
+ ext := utils.FileRuntimeExtensionsMap[wskAction.Exec.Kind]
+
+ manifestDir := filepath.Dir(utils.Flags.ManifestPath)
+
+ // store function file under action package name subdirectory in the specified manifest folder
+ functionDir := filepath.Join(manifestDir, packageName)
+ os.MkdirAll(functionDir, os.ModePerm)
+
+ // store function in manifest under path relative to manifest root
+ functionFile := filepath.Join(packageName, wskAction.Name) + "." + ext
+ parsedAction.Function = functionFile
+
+ // create function file at the full path
+ functionFile = filepath.Join(manifestDir, functionFile)
+ f, err := os.Create(functionFile)
+ if err != nil {
+ return wskderrors.NewFileReadError(functionFile, err.Error())
+ }
+
+ defer f.Close()
+
+ // store action function in the filesystem next to the manifest.yml
+ // TODO: consider to name files by namespace + action to make function file names uniqueue
+ f.Write([]byte(*wskAction.Exec.Code))
+ pkg.Actions[wskAction.Name] = parsedAction
+ }
+
+ maniyaml.Packages[packageName] = pkg
+ return nil
+}
+
+func ExportCmdImp(cmd *cobra.Command, args []string) error {
+
+ projectName := utils.Flags.ProjectPath
+ maniyaml := &parsers.YAML{}
+ maniyaml.Project.Name = projectName
+
+ config, _ = deployers.NewWhiskConfig(wskpropsPath, utils.Flags.DeploymentPath, utils.Flags.ManifestPath, false)
+ client, _ = deployers.CreateNewClient(config)
+
+ // Init supported runtimes and action files extensions maps
+ setSupportedRuntimes(config.Host)
+
+ // Get the list of packages in your namespace
+ packages, _, err := client.Packages.List(&whisk.PackageListOptions{})
+ if err != nil {
+ return err
+ }
+
+ // iterate over each package to find managed annotations
+ // check if "managed" annotation is attached to a package
+ // add to export when managed project name matches with the
+ // specified project name
+ for _, pkg := range packages {
+ if a := pkg.Annotations.GetValue(utils.MANAGED); a != nil {
+ // decode the JSON blob and retrieve __OW_PROJECT_NAME
+ pa := a.(map[string]interface{})
+
+ // we have found a package which is part of the current project
+ if pa[utils.OW_PROJECT_NAME] == projectName {
+
+ if maniyaml.Packages == nil {
+ maniyaml.Packages = make(map[string]parsers.Package)
+ }
+
+ maniyaml.Packages[pkg.Name] = *maniyaml.ComposeParsersPackage(pkg)
+ // TODO: throw if there more than single package managed by project
+ // currently will be a mess because triggers and rules managed under packages
+ // instead of the top level (similar to OW model)
+ if len(maniyaml.Packages) > 1 {
+ return errors.New("currently can't work with more than one package managed by one project")
+ }
+
+ // perform the similar check on the list of actions from this package
+ // get a list of actions in your namespace
+ actions, _, err := client.Actions.List(pkg.Name, &whisk.ActionListOptions{})
+ if err != nil {
+ return err
+ }
+
+ // iterate over list of managed package actions to find an action with managed annotations
+ // check if "managed" annotation is attached to an action
+ for _, action := range actions {
+ // TODO: consider to throw error when there unmanaged or "foreign" assets under managed package
+ // an annotation with "managed" key indicates that an action was deployed as part of managed deployment
+ // if such annotation exists, check if it belongs to the current managed deployment
+ // this action has attached managed annotations
+ if a := action.Annotations.GetValue(utils.MANAGED); a != nil {
+ aa := a.(map[string]interface{})
+ if aa[utils.OW_PROJECT_NAME] == projectName {
+ actionName := strings.Join([]string{pkg.Name, action.Name}, "/")
+ // export action to file system
+ err = ExportAction(actionName, pkg.Name, maniyaml)
+ if err != nil {
+ return err
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+ // Get list of triggers in your namespace
+ triggers, _, err := client.Triggers.List(&whisk.TriggerListOptions{})
+ if err != nil {
+ return err
+ }
+
+ // iterate over the list of triggers to determine whether any of them part of specified managed project
+ for _, trg := range triggers {
+ // trigger has attached managed annotation
+ if a := trg.Annotations.GetValue(utils.MANAGED); a != nil {
+ // decode the JSON blob and retrieve __OW_PROJECT_NAME
+ ta := a.(map[string]interface{})
+ if ta[utils.OW_PROJECT_NAME] == projectName {
+
+ // for i := 0; i < len(maniyaml.Packages); i++ {
+ for pkgName := range maniyaml.Packages {
+ if maniyaml.Packages[pkgName].Namespace == trg.Namespace {
+ if maniyaml.Packages[pkgName].Triggers == nil {
+ pkg := maniyaml.Packages[pkgName]
+ pkg.Triggers = make(map[string]parsers.Trigger)
+ maniyaml.Packages[pkgName] = pkg
+ }
+
+ // export trigger to manifest
+ maniyaml.Packages[pkgName].Triggers[trg.Name] = *maniyaml.ComposeParsersTrigger(trg)
+ }
+ }
+ }
+ }
+ }
+
+ // Get list of rules from OW
+ rules, _, err := client.Rules.List(&whisk.RuleListOptions{})
+ if err != nil {
+ return err
+ }
+
+ // TODO: can be simplifyed once OW permits to add annotation to rules
+ // iterate over the list of rules to determine whether any of them is part of
+ // managed trigger -> action set for specified managed project. if yes, add to manifest
+ for _, rule := range rules {
+ // get rule from OW
+ wskRule, _, _ := client.Rules.Get(rule.Name)
+ ruleAction := wskRule.Action.(map[string]interface{})["name"].(string)
+ ruleTrigger := wskRule.Trigger.(map[string]interface{})["name"].(string)
+
+ // can be simplified once rules moved to top level next to triggers
+ for pkgName := range maniyaml.Packages {
+ if maniyaml.Packages[pkgName].Namespace == wskRule.Namespace {
+ // iterate over all managed triggers in manifest
+ for _, trigger := range maniyaml.Packages[pkgName].Triggers {
+ // check that managed trigger equals to rule trigger
+ if ruleTrigger == trigger.Name && trigger.Namespace == wskRule.Namespace {
+ // check that there a managed action (or sequence action) equals to rule action
+ for _, action := range maniyaml.Packages[pkgName].Actions {
+ if action.Name == ruleAction {
+ // export rule to manifest
+ ExportRule(*wskRule, pkgName, maniyaml)
+ }
+ }
+
+ // check that there a managed sequence action with name matching the rule action
+ for name := range maniyaml.Packages[pkgName].Sequences {
+ if name == ruleAction {
+ // export rule to manifest
+ ExportRule(*wskRule, pkgName, maniyaml)
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+ parsers.Write(maniyaml, utils.Flags.ManifestPath)
+ fmt.Println("Manifest exported to: " + utils.Flags.ManifestPath)
+
+ return nil
+}
+
+func init() {
+ RootCmd.AddCommand(exportCmd)
+ exportCmd.Flags().StringVarP(&utils.Flags.ProjectPath, "project", "p", ".", "name of the managed project")
+ exportCmd.Flags().StringVarP(&utils.Flags.ManifestPath, "manifest", "m", "", "path to manifest file to save exported data")
+}
diff --git a/cmd/root.go b/cmd/root.go
index a2da30b..6e241b3 100644
--- a/cmd/root.go
+++ b/cmd/root.go
@@ -21,6 +21,12 @@ import (
"encoding/json"
"errors"
"fmt"
+ "os"
+ "path"
+ "path/filepath"
+ "regexp"
+ "strings"
+
"github.com/apache/incubator-openwhisk-client-go/whisk"
"github.com/apache/incubator-openwhisk-wskdeploy/deployers"
"github.com/apache/incubator-openwhisk-wskdeploy/utils"
@@ -28,11 +34,6 @@ import (
"github.com/apache/incubator-openwhisk-wskdeploy/wski18n"
"github.com/apache/incubator-openwhisk-wskdeploy/wskprint"
"github.com/spf13/cobra"
- "os"
- "path"
- "path/filepath"
- "regexp"
- "strings"
)
var stderr = ""
@@ -161,6 +162,7 @@ func setSupportedRuntimes(apiHost string) {
utils.SupportedRunTimes = utils.ConvertToMap(op)
utils.DefaultRunTimes = utils.DefaultRuntimes(op)
utils.FileExtensionRuntimeKindMap = utils.FileExtensionRuntimes(op)
+ utils.FileRuntimeExtensionsMap = utils.FileRuntimeExtensions(op)
}
}
diff --git a/parsers/yamlparser.go b/parsers/yamlparser.go
index 7e51714..94227af 100644
--- a/parsers/yamlparser.go
+++ b/parsers/yamlparser.go
@@ -359,3 +359,60 @@ func (pkg *Package) GetApis() []*whisk.Api {
}
return apis
}
+
+//********************YAML functions*************************//
+func (yaml *YAML) ComposeParsersPackage(wskpag whisk.Package) *Package {
+ pkg := new(Package)
+ pkg.Packagename = wskpag.Name
+ pkg.Namespace = wskpag.Namespace
+ pkg.Version = wskpag.Version
+
+ for _, keyval := range wskpag.Parameters {
+ param := new(Parameter)
+ param.Value = keyval.Value
+ pkg.Inputs[keyval.Key] = *param
+ }
+
+ return pkg
+}
+
+func (yaml *YAML) ComposeParsersAction(wskact whisk.Action) *Action {
+ action := new(Action)
+ action.Name = wskact.Name
+ action.Namespace = wskact.Namespace
+ action.Version = wskact.Version
+ action.Runtime = wskact.Exec.Kind
+
+ action.Inputs = make(map[string]Parameter)
+ for _, keyval := range wskact.Parameters {
+ param := new(Parameter)
+ param.Value = keyval.Value
+ action.Inputs[keyval.Key] = *param
+ }
+
+ return action
+}
+
+func (yaml *YAML) ComposeParsersTrigger(wsktrg whisk.Trigger) *Trigger {
+ trigger := new(Trigger)
+ trigger.Name = wsktrg.Name
+ trigger.Namespace = wsktrg.Namespace
+
+ for _, keyval := range wsktrg.Parameters {
+ param := new(Parameter)
+ param.Value = keyval.Value
+ trigger.Inputs[keyval.Key] = *param
+ }
+
+ return trigger
+}
+
+func (yaml *YAML) ComposeParsersRule(wskrule whisk.Rule) *Rule {
+ rule := new(Rule)
+ rule.Name = wskrule.Name
+
+ rule.Action = wskrule.Action.(map[string]interface{})["name"].(string)
+ rule.Trigger = wskrule.Trigger.(map[string]interface{})["name"].(string)
+
+ return rule
+}
diff --git a/utils/runtimes.go b/utils/runtimes.go
index dc2721c..cacf980 100644
--- a/utils/runtimes.go
+++ b/utils/runtimes.go
@@ -68,6 +68,7 @@ type OpenWhiskInfo struct {
var FileExtensionRuntimeKindMap map[string]string
var SupportedRunTimes map[string][]string
var DefaultRunTimes map[string]string
+var FileRuntimeExtensionsMap map[string]string
// We could get the openwhisk info from bluemix through running the command
// `curl -k https://openwhisk.ng.bluemix.net`
@@ -165,6 +166,29 @@ func FileExtensionRuntimes(op OpenWhiskInfo) (ext map[string]string) {
return
}
+func FileRuntimeExtensions(op OpenWhiskInfo) (rte map[string]string) {
+ rte = make(map[string]string)
+
+ for k, v := range op.Runtimes {
+ for i := range v {
+ if !v[i].Deprecated {
+ if strings.Contains(k, NODEJS_FILE_EXTENSION) {
+ rte[v[i].Kind] = NODEJS_FILE_EXTENSION
+ } else if strings.Contains(k, PYTHON_FILE_EXTENSION) {
+ rte[v[i].Kind] = PYTHON_FILE_EXTENSION
+ } else if strings.Contains(k, SWIFT_FILE_EXTENSION) {
+ rte[v[i].Kind] = SWIFT_FILE_EXTENSION
+ } else if strings.Contains(k, PHP_FILE_EXTENSION) {
+ rte[v[i].Kind] = PHP_FILE_EXTENSION
+ } else if strings.Contains(k, JAVA_FILE_EXTENSION) {
+ rte[v[i].Kind] = JAVA_FILE_EXTENSION
+ }
+ }
+ }
+ }
+ return
+}
+
func CheckRuntimeConsistencyWithFileExtension(ext string, runtime string) bool {
rt := FileExtensionRuntimeKindMap[ext]
for _, v := range SupportedRunTimes[rt] {
--
To stop receiving notification emails like this one, please contact
mrutkowski@apache.org.