hs-test: add tls proxy test
[vpp.git] / extras / hs-test / vppinstance.go
index 15524b8..e909b85 100644 (file)
@@ -1,14 +1,31 @@
 package main
 
 import (
-       "encoding/json"
        "fmt"
+       "os"
+       "os/exec"
+       "os/signal"
+       "strconv"
+       "strings"
+       "syscall"
+       "time"
+
        "github.com/edwarnicke/exechelper"
+
+       "go.fd.io/govpp"
+       "go.fd.io/govpp/api"
+       "go.fd.io/govpp/binapi/af_packet"
+       interfaces "go.fd.io/govpp/binapi/interface"
+       "go.fd.io/govpp/binapi/interface_types"
+       "go.fd.io/govpp/binapi/session"
+       "go.fd.io/govpp/binapi/tapv2"
+       "go.fd.io/govpp/binapi/vpe"
+       "go.fd.io/govpp/core"
 )
 
 const vppConfigTemplate = `unix {
   nodaemon
-  log %[1]s/var/log/vpp/vpp.log
+  log %[1]s%[4]s
   full-coredump
   cli-listen %[1]s%[2]s
   runtime-dir %[1]s/var/run
@@ -24,7 +41,7 @@ api-segment {
 }
 
 socksvr {
-  socket-name %[1]s/var/run/vpp/api.sock
+  socket-name %[1]s%[3]s
 }
 
 statseg {
@@ -32,110 +49,341 @@ statseg {
 }
 
 plugins {
+  plugin default { disable }
+
   plugin unittest_plugin.so { enable }
-  plugin dpdk_plugin.so { disable }
-  plugin crypto_aesni_plugin.so { enable }
   plugin quic_plugin.so { enable }
+  plugin af_packet_plugin.so { enable }
+  plugin hs_apps_plugin.so { enable }
+  plugin http_plugin.so { enable }
+  plugin http_static_plugin.so { enable }
+  plugin prom_plugin.so { enable }
+  plugin tlsopenssl_plugin.so { enable }
+}
+
+logging {
+  default-log-level debug
+  default-syslog-log-level debug
 }
 
 `
 
 const (
        defaultCliSocketFilePath = "/var/run/vpp/cli.sock"
+       defaultApiSocketFilePath = "/var/run/vpp/api.sock"
+       defaultLogFilePath       = "/var/log/vpp/vpp.log"
 )
 
 type VppInstance struct {
-       container      *Container
-       config         VppConfig
-       actionFuncName string
+       container        *Container
+       additionalConfig []Stanza
+       connection       *core.Connection
+       apiChannel       api.Channel
+       cpus             []int
 }
 
-type VppConfig struct {
-       Variant           string
-       CliSocketFilePath string
+func (vpp *VppInstance) getSuite() *HstSuite {
+       return vpp.container.suite
 }
 
-func (vc *VppConfig) getTemplate() string {
-       return fmt.Sprintf(vppConfigTemplate, "%[1]s", vc.CliSocketFilePath)
+func (vpp *VppInstance) getCliSocket() string {
+       return fmt.Sprintf("%s%s", vpp.container.getContainerWorkDir(), defaultCliSocketFilePath)
+}
+
+func (vpp *VppInstance) getRunDir() string {
+       return vpp.container.getContainerWorkDir() + "/var/run/vpp"
 }
 
-func (vpp *VppInstance) set2VethsServer() {
-       vpp.actionFuncName = "Configure2Veths"
-       vpp.config.Variant = "srv"
+func (vpp *VppInstance) getLogDir() string {
+       return vpp.container.getContainerWorkDir() + "/var/log/vpp"
 }
 
-func (vpp *VppInstance) set2VethsClient() {
-       vpp.actionFuncName = "Configure2Veths"
-       vpp.config.Variant = "cln"
+func (vpp *VppInstance) getEtcDir() string {
+       return vpp.container.getContainerWorkDir() + "/etc/vpp"
 }
 
-func (vpp *VppInstance) setVppProxy() {
-       vpp.actionFuncName = "ConfigureVppProxy"
+func (vpp *VppInstance) start() error {
+       // Create folders
+       containerWorkDir := vpp.container.getContainerWorkDir()
+
+       vpp.container.exec("mkdir --mode=0700 -p " + vpp.getRunDir())
+       vpp.container.exec("mkdir --mode=0700 -p " + vpp.getLogDir())
+       vpp.container.exec("mkdir --mode=0700 -p " + vpp.getEtcDir())
+
+       // Create startup.conf inside the container
+       configContent := fmt.Sprintf(
+               vppConfigTemplate,
+               containerWorkDir,
+               defaultCliSocketFilePath,
+               defaultApiSocketFilePath,
+               defaultLogFilePath,
+       )
+       configContent += vpp.generateCpuConfig()
+       for _, c := range vpp.additionalConfig {
+               configContent += c.toString()
+       }
+       startupFileName := vpp.getEtcDir() + "/startup.conf"
+       vpp.container.createFile(startupFileName, configContent)
+
+       // create wrapper script for vppctl with proper CLI socket path
+       cliContent := "#!/usr/bin/bash\nvppctl -s " + vpp.getRunDir() + "/cli.sock"
+       vppcliFileName := "/usr/bin/vppcli"
+       vpp.container.createFile(vppcliFileName, cliContent)
+       vpp.container.exec("chmod 0755 " + vppcliFileName)
+
+       if *isVppDebug {
+               sig := make(chan os.Signal, 1)
+               signal.Notify(sig, syscall.SIGINT)
+               cont := make(chan bool, 1)
+               go func() {
+                       <-sig
+                       cont <- true
+               }()
+
+               vpp.container.execServer("su -c \"vpp -c " + startupFileName + " &> /proc/1/fd/1\"")
+               fmt.Println("run following command in different terminal:")
+               fmt.Println("docker exec -it " + vpp.container.name + " gdb -ex \"attach $(docker exec " + vpp.container.name + " pidof vpp)\"")
+               fmt.Println("Afterwards press CTRL+C to continue")
+               <-cont
+               fmt.Println("continuing...")
+       } else {
+               // Start VPP
+               vpp.container.execServer("su -c \"vpp -c " + startupFileName + " &> /proc/1/fd/1\"")
+       }
+
+       // Connect to VPP and store the connection
+       sockAddress := vpp.container.getHostWorkDir() + defaultApiSocketFilePath
+       conn, connEv, err := govpp.AsyncConnect(
+               sockAddress,
+               core.DefaultMaxReconnectAttempts,
+               core.DefaultReconnectInterval)
+       if err != nil {
+               fmt.Println("async connect error: ", err)
+       }
+       vpp.connection = conn
+
+       // ... wait for Connected event
+       e := <-connEv
+       if e.State != core.Connected {
+               fmt.Println("connecting to VPP failed: ", e.Error)
+       }
+
+       // ... check compatibility of used messages
+       ch, err := conn.NewAPIChannel()
+       if err != nil {
+               fmt.Println("creating channel failed: ", err)
+       }
+       if err := ch.CheckCompatiblity(vpe.AllMessages()...); err != nil {
+               fmt.Println("compatibility error: ", err)
+       }
+       if err := ch.CheckCompatiblity(interfaces.AllMessages()...); err != nil {
+               fmt.Println("compatibility error: ", err)
+       }
+       vpp.apiChannel = ch
+
+       return nil
 }
 
-func (vpp *VppInstance) setEnvoyProxy() {
-       vpp.actionFuncName = "ConfigureEnvoyProxy"
+func (vpp *VppInstance) vppctl(command string, arguments ...any) string {
+       vppCliCommand := fmt.Sprintf(command, arguments...)
+       containerExecCommand := fmt.Sprintf("docker exec --detach=false %[1]s vppctl -s %[2]s %[3]s",
+               vpp.container.name, vpp.getCliSocket(), vppCliCommand)
+       vpp.getSuite().log(containerExecCommand)
+       output, err := exechelper.CombinedOutput(containerExecCommand)
+       vpp.getSuite().assertNil(err)
+
+       return string(output)
 }
 
-func (vpp *VppInstance) setCliSocket(filePath string) {
-       vpp.config.CliSocketFilePath = filePath
+func (vpp *VppInstance) GetSessionStat(stat string) int {
+       o := vpp.vppctl("show session stats")
+       vpp.getSuite().log(o)
+       for _, line := range strings.Split(o, "\n") {
+               if strings.Contains(line, stat) {
+                       tokens := strings.Split(strings.TrimSpace(line), " ")
+                       val, err := strconv.Atoi(tokens[0])
+                       if err != nil {
+                               vpp.getSuite().FailNow("failed to parse stat value %s", err)
+                               return 0
+                       }
+                       return val
+               }
+       }
+       return 0
 }
 
-func (vpp *VppInstance) getCliSocket() string {
-       return fmt.Sprintf("%s%s", vpp.container.workDir, vpp.config.CliSocketFilePath)
+func (vpp *VppInstance) waitForApp(appName string, timeout int) {
+       for i := 0; i < timeout; i++ {
+               o := vpp.vppctl("show app")
+               if strings.Contains(o, appName) {
+                       return
+               }
+               time.Sleep(1 * time.Second)
+       }
+       vpp.getSuite().assertNil(1, "Timeout while waiting for app '%s'", appName)
 }
 
-func (vpp *VppInstance) start() error {
-       if vpp.actionFuncName == "" {
-               return fmt.Errorf("vpp start failed: action function name must not be blank")
+func (vpp *VppInstance) createAfPacket(
+       veth *NetInterface,
+) (interface_types.InterfaceIndex, error) {
+       createReq := &af_packet.AfPacketCreateV2{
+               UseRandomHwAddr: true,
+               HostIfName:      veth.Name(),
+       }
+       if veth.hwAddress != (MacAddress{}) {
+               createReq.UseRandomHwAddr = false
+               createReq.HwAddr = veth.hwAddress
        }
+       createReply := &af_packet.AfPacketCreateV2Reply{}
 
-       serializedConfig, err := serializeVppConfig(vpp.config)
-       args := fmt.Sprintf("%s '%s'", vpp.actionFuncName, serializedConfig)
-       _, err = vpp.container.execAction(args)
-       if err != nil {
-               return fmt.Errorf("vpp start failed: %s", err)
+       if err := vpp.apiChannel.SendRequest(createReq).ReceiveReply(createReply); err != nil {
+               return 0, err
+       }
+       veth.index = createReply.SwIfIndex
+
+       // Set to up
+       upReq := &interfaces.SwInterfaceSetFlags{
+               SwIfIndex: veth.index,
+               Flags:     interface_types.IF_STATUS_API_FLAG_ADMIN_UP,
+       }
+       upReply := &interfaces.SwInterfaceSetFlagsReply{}
+
+       if err := vpp.apiChannel.SendRequest(upReq).ReceiveReply(upReply); err != nil {
+               return 0, err
+       }
+
+       // Add address
+       if veth.addressWithPrefix() == (AddressWithPrefix{}) {
+               var err error
+               var ip4Address string
+               if ip4Address, err = veth.ip4AddrAllocator.NewIp4InterfaceAddress(veth.peer.networkNumber); err == nil {
+                       veth.ip4Address = ip4Address
+               } else {
+                       return 0, err
+               }
+       }
+       addressReq := &interfaces.SwInterfaceAddDelAddress{
+               IsAdd:     true,
+               SwIfIndex: veth.index,
+               Prefix:    veth.addressWithPrefix(),
+       }
+       addressReply := &interfaces.SwInterfaceAddDelAddressReply{}
+
+       if err := vpp.apiChannel.SendRequest(addressReq).ReceiveReply(addressReply); err != nil {
+               return 0, err
+       }
+
+       return veth.index, nil
+}
+
+func (vpp *VppInstance) addAppNamespace(
+       secret uint64,
+       ifx interface_types.InterfaceIndex,
+       namespaceId string,
+) error {
+       req := &session.AppNamespaceAddDelV2{
+               Secret:      secret,
+               SwIfIndex:   ifx,
+               NamespaceID: namespaceId,
+       }
+       reply := &session.AppNamespaceAddDelV2Reply{}
+
+       if err := vpp.apiChannel.SendRequest(req).ReceiveReply(reply); err != nil {
+               return err
+       }
+
+       sessionReq := &session.SessionEnableDisable{
+               IsEnable: true,
+       }
+       sessionReply := &session.SessionEnableDisableReply{}
+
+       if err := vpp.apiChannel.SendRequest(sessionReq).ReceiveReply(sessionReply); err != nil {
+               return err
        }
 
        return nil
 }
 
-func (vpp *VppInstance) vppctl(command string) (string, error) {
-       cliExecCommand := fmt.Sprintf("docker exec --detach=false %[1]s vppctl -s %[2]s %[3]s",
-               vpp.container.name, vpp.getCliSocket(), command)
-       output, err := exechelper.CombinedOutput(cliExecCommand)
-       if err != nil {
-               return "", fmt.Errorf("vppctl failed: %s", err)
+func (vpp *VppInstance) createTap(
+       tap *NetInterface,
+       tapId ...uint32,
+) error {
+       var id uint32 = 1
+       if len(tapId) > 0 {
+               id = tapId[0]
+       }
+       createTapReq := &tapv2.TapCreateV2{
+               ID:               id,
+               HostIfNameSet:    true,
+               HostIfName:       tap.Name(),
+               HostIP4PrefixSet: true,
+               HostIP4Prefix:    tap.ip4AddressWithPrefix(),
+       }
+       createTapReply := &tapv2.TapCreateV2Reply{}
+
+       // Create tap interface
+       if err := vpp.apiChannel.SendRequest(createTapReq).ReceiveReply(createTapReply); err != nil {
+               return err
+       }
+
+       // Add address
+       addAddressReq := &interfaces.SwInterfaceAddDelAddress{
+               IsAdd:     true,
+               SwIfIndex: createTapReply.SwIfIndex,
+               Prefix:    tap.peer.addressWithPrefix(),
+       }
+       addAddressReply := &interfaces.SwInterfaceAddDelAddressReply{}
+
+       if err := vpp.apiChannel.SendRequest(addAddressReq).ReceiveReply(addAddressReply); err != nil {
+               return err
+       }
+
+       // Set interface to up
+       upReq := &interfaces.SwInterfaceSetFlags{
+               SwIfIndex: createTapReply.SwIfIndex,
+               Flags:     interface_types.IF_STATUS_API_FLAG_ADMIN_UP,
+       }
+       upReply := &interfaces.SwInterfaceSetFlagsReply{}
+
+       if err := vpp.apiChannel.SendRequest(upReq).ReceiveReply(upReply); err != nil {
+               return err
        }
 
-       return string(output), nil
+       return nil
 }
 
-func NewVppInstance(c *Container) *VppInstance {
-       var vppConfig VppConfig
-       vppConfig.CliSocketFilePath = defaultCliSocketFilePath
-       vpp := new(VppInstance)
-       vpp.container = c
-       vpp.config = vppConfig
-       return vpp
+func (vpp *VppInstance) saveLogs() {
+       logTarget := vpp.container.getLogDirPath() + "vppinstance-" + vpp.container.name + ".log"
+       logSource := vpp.container.getHostWorkDir() + defaultLogFilePath
+       cmd := exec.Command("cp", logSource, logTarget)
+       vpp.getSuite().T().Helper()
+       vpp.getSuite().log(cmd.String())
+       cmd.Run()
 }
 
-func serializeVppConfig(vppConfig VppConfig) (string, error) {
-       serializedConfig, err := json.Marshal(vppConfig)
-       if err != nil {
-               return "", fmt.Errorf("vpp start failed: serializing configuration failed: %s", err)
-       }
-       return string(serializedConfig), nil
+func (vpp *VppInstance) disconnect() {
+       vpp.connection.Disconnect()
+       vpp.apiChannel.Close()
 }
 
-func deserializeVppConfig(input string) (VppConfig, error) {
-       var vppConfig VppConfig
-       err := json.Unmarshal([]byte(input), &vppConfig)
-       if err != nil {
-               // Since input is not a  valid JSON it is going be used as a variant value
-               // for compatibility reasons
-               vppConfig.Variant = input
-               vppConfig.CliSocketFilePath = defaultCliSocketFilePath
+func (vpp *VppInstance) generateCpuConfig() string {
+       var c Stanza
+       var s string
+       if len(vpp.cpus) < 1 {
+               return ""
+       }
+       c.newStanza("cpu").
+               append(fmt.Sprintf("main-core %d", vpp.cpus[0]))
+       workers := vpp.cpus[1:]
+
+       if len(workers) > 0 {
+               for i := 0; i < len(workers); i++ {
+                       if i != 0 {
+                               s = s + ", "
+                       }
+                       s = s + fmt.Sprintf("%d", workers[i])
+               }
+               c.append(fmt.Sprintf("corelist-workers %s", s))
        }
-       return vppConfig, nil
+       return c.close().toString()
 }