lib/agent/project-pathmap.go

   1 /*
   2  * Copyright (C) 2017-2018 "IoT.bzh"
   3  * Author Sebastien Douheret <sebastien@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package agent
  19
  20 import (
  21         "fmt"
  22         "io/ioutil"
  23         "os"
  24         "strings"
  25
  26         "gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xaapiv1"
  27         common "gerrit.automotivelinux.org/gerrit/src/xds/xds-common.git"
  28         "gerrit.automotivelinux.org/gerrit/src/xds/xds-server.git/lib/xsapiv1"
  29 )
  30
  31 // IPROJECT interface implementation for native/path mapping projects
  32
  33 // PathMap .
  34 type PathMap struct {
  35         *Context
  36         server *XdsServer
  37         folder *xsapiv1.FolderConfig
  38 }
  39
  40 // NewProjectPathMap Create a new instance of PathMap
  41 func NewProjectPathMap(ctx *Context, svr *XdsServer) *PathMap {
  42         p := PathMap{
  43                 Context: ctx,
  44                 server:  svr,
  45                 folder:  &xsapiv1.FolderConfig{},
  46         }
  47         return &p
  48 }
  49
  50 // Add a new project
  51 func (p *PathMap) Add(cfg xaapiv1.ProjectConfig) (*xaapiv1.ProjectConfig, error) {
  52         var err error
  53         var file *os.File
  54         errMsg := "ClientPath sanity check error (%d): %v"
  55
  56         // Sanity check to verify that we have RW permission and path-mapping is correct
  57         dir := cfg.ClientPath
  58         if !common.Exists(dir) {
  59                 // try to create if not existing
  60                 if err := os.MkdirAll(dir, 0755); err != nil {
  61                         return nil, fmt.Errorf("Cannot create ClientPath directory: %s", dir)
  62                 }
  63         }
  64         if !common.Exists(dir) {
  65                 return nil, fmt.Errorf("ClientPath directory is not accessible: %s", dir)
  66         }
  67         if file, err = ioutil.TempFile(dir, ".xds_pathmap_check"); err != nil {
  68                 return nil, fmt.Errorf(errMsg, 1, err)
  69         }
  70         // Write a specific message that will be check by server during folder add
  71         msg := "Pathmap checked message written by xds-agent ID: " + p.Config.AgentUID + "\n"
  72         if n, err := file.WriteString(msg); n != len(msg) || err != nil {
  73                 return nil, fmt.Errorf(errMsg, 2, err)
  74         }
  75         defer func() {
  76                 if file != nil {
  77                         os.Remove(file.Name())
  78                         file.Close()
  79                 }
  80         }()
  81
  82         // Convert to Xds folder
  83         fld := p.server.ProjectToFolder(cfg)
  84         fld.DataPathMap.CheckFile = file.Name()
  85         fld.DataPathMap.CheckContent = msg
  86
  87         // Send request to create folder on XDS server side
  88         err = p.server.FolderAdd(fld, p.folder)
  89         if err != nil {
  90                 return nil, err
  91         }
  92
  93         // 2nd part of sanity checker
  94         // check specific message added by XDS Server during folder add processing
  95         content, err := ioutil.ReadFile(file.Name())
  96         if err != nil {
  97                 return nil, fmt.Errorf(errMsg, 3, err)
  98         }
  99         if !strings.Contains(string(content),
 100                 "Pathmap checked message written by xds-server ID") {
 101                 return nil, fmt.Errorf(errMsg, 4, "file content differ")
 102         }
 103
 104         return p.GetProject(), nil
 105 }
 106
 107 // Delete a project
 108 func (p *PathMap) Delete() error {
 109         return p.server.FolderDelete(p.folder.ID)
 110 }
 111
 112 // GetProject Get public part of project config
 113 func (p *PathMap) GetProject() *xaapiv1.ProjectConfig {
 114         prj := p.server.FolderToProject(*p.folder)
 115         prj.ServerID = p.server.ID
 116         return &prj
 117 }
 118
 119 // Setup Setup local project config
 120 func (p *PathMap) Setup(prj xaapiv1.ProjectConfig) (*xaapiv1.ProjectConfig, error) {
 121         p.folder = p.server.ProjectToFolder(prj)
 122         np := p.GetProject()
 123         if err := p.events.Emit(xaapiv1.EVTProjectChange, np, ""); err != nil {
 124                 return np, err
 125         }
 126         return np, nil
 127 }
 128
 129 // Update Update some field of a project
 130 func (p *PathMap) Update(prj xaapiv1.ProjectConfig) (*xaapiv1.ProjectConfig, error) {
 131         if p.folder.ID != prj.ID {
 132                 return nil, fmt.Errorf("Invalid id")
 133         }
 134
 135         err := p.server.FolderUpdate(p.server.ProjectToFolder(prj), p.folder)
 136         if err != nil {
 137                 return nil, err
 138         }
 139
 140         return p.GetProject(), nil
 141 }
 142
 143 // GetServer Get the XdsServer that holds this project
 144 func (p *PathMap) GetServer() *XdsServer {
 145         return p.server
 146 }
 147
 148 // Sync Force project files synchronization
 149 func (p *PathMap) Sync() error {
 150         return nil
 151 }
 152
 153 // IsInSync Check if project files are in-sync
 154 func (p *PathMap) IsInSync() (bool, error) {
 155         return true, nil
 156 }