mirror of
https://github.com/redhat-developer/odo.git
synced 2025-10-19 03:06:19 +03:00
b93a75c11a
* Make UI not experimental * Display API and UI URLs * Remove link to old sources * Fix integration tests * Add UI to Usage Data * Add a "Using the GUI to edit the Devfile" page to doc * Add link to odo.dev specific page * Apply suggestions from code review Co-authored-by: Armel Soro <armel@rm3l.org> * Change favicon with odo logo * Display web console URL as part of the Dev status * Update UI static files * Document that Comments not supported * Add UI screenshots --------- Co-authored-by: Armel Soro <armel@rm3l.org>
295 lines
10 KiB
Go
295 lines
10 KiB
Go
package integration
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"path/filepath"
|
|
"strconv"
|
|
"time"
|
|
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
"k8s.io/utils/pointer"
|
|
|
|
"github.com/redhat-developer/odo/pkg/labels"
|
|
"github.com/redhat-developer/odo/tests/helper"
|
|
)
|
|
|
|
var _ = Describe("odo dev command with api server tests", func() {
|
|
var cmpName string
|
|
var commonVar helper.CommonVar
|
|
|
|
// This is run before every Spec (It)
|
|
var _ = BeforeEach(func() {
|
|
commonVar = helper.CommonBeforeEach()
|
|
cmpName = helper.RandString(6)
|
|
helper.Chdir(commonVar.Context)
|
|
Expect(helper.VerifyFileExists(".odo/env/env.yaml")).To(BeFalse())
|
|
})
|
|
|
|
// This is run after every Spec (It)
|
|
var _ = AfterEach(func() {
|
|
helper.CommonAfterEach(commonVar)
|
|
})
|
|
|
|
for _, podman := range []bool{false, true} {
|
|
podman := podman
|
|
|
|
When("the component is bootstrapped", helper.LabelPodmanIf(podman, func() {
|
|
BeforeEach(func() {
|
|
helper.CopyExample(filepath.Join("source", "devfiles", "nodejs", "project"), commonVar.Context)
|
|
helper.CopyExampleDevFile(filepath.Join("source", "devfiles", "nodejs", "devfile.yaml"), filepath.Join(commonVar.Context, "devfile.yaml"), cmpName)
|
|
})
|
|
|
|
It("should fail if --api-server is false but --api-server-port is true", func() {
|
|
args := []string{
|
|
"dev",
|
|
"--api-server=false",
|
|
fmt.Sprintf("--api-server-port=%d", helper.GetCustomStartPort()),
|
|
}
|
|
if podman {
|
|
args = append(args, "--platform=podman")
|
|
}
|
|
errOut := helper.Cmd("odo", args...).ShouldFail().Err()
|
|
Expect(errOut).To(ContainSubstring("--api-server-port makes sense only if --api-server is enabled"))
|
|
})
|
|
|
|
for _, customPort := range []bool{false, true} {
|
|
customPort := customPort
|
|
|
|
if customPort {
|
|
It("should fail if --random-ports and --api-server-port are used together", func() {
|
|
args := []string{
|
|
"dev",
|
|
"--random-ports",
|
|
fmt.Sprintf("--api-server-port=%d", helper.GetCustomStartPort()),
|
|
}
|
|
if podman {
|
|
args = append(args, "--platform=podman")
|
|
}
|
|
errOut := helper.Cmd("odo", args...).ShouldFail().Err()
|
|
Expect(errOut).Should(ContainSubstring("--random-ports and --api-server-port cannot be used together"))
|
|
})
|
|
}
|
|
|
|
When(fmt.Sprintf("odo dev is run with --api-server flag (custom api server port=%v)", customPort), func() {
|
|
var devSession helper.DevSession
|
|
var localPort int
|
|
BeforeEach(func() {
|
|
opts := helper.DevSessionOpts{
|
|
RunOnPodman: podman,
|
|
StartAPIServer: true,
|
|
}
|
|
if customPort {
|
|
localPort = helper.GetCustomStartPort()
|
|
opts.APIServerPort = localPort
|
|
opts.NoRandomPorts = true
|
|
}
|
|
var err error
|
|
devSession, err = helper.StartDevMode(opts)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
AfterEach(func() {
|
|
devSession.Stop()
|
|
devSession.WaitEnd()
|
|
})
|
|
It("should start the Dev server when --api-server flag is passed", func() {
|
|
if customPort {
|
|
Expect(devSession.APIServerEndpoint).To(ContainSubstring(fmt.Sprintf("%d", localPort)))
|
|
}
|
|
url := fmt.Sprintf("http://%s/instance", devSession.APIServerEndpoint)
|
|
resp, err := http.Get(url)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(resp.StatusCode).To(BeEquivalentTo(http.StatusOK))
|
|
})
|
|
|
|
It("should describe the API Server port", func() {
|
|
args := []string{"describe", "component"}
|
|
if podman {
|
|
args = append(args, "--platform", "podman")
|
|
}
|
|
stdout := helper.Cmd("odo", args...).ShouldPass().Out()
|
|
Expect(stdout).To(ContainSubstring("Dev Control Plane"))
|
|
Expect(stdout).To(ContainSubstring("API: http://%s", devSession.APIServerEndpoint))
|
|
if customPort {
|
|
Expect(stdout).To(ContainSubstring("Web UI: http://localhost:%d/", localPort))
|
|
} else {
|
|
Expect(stdout).To(MatchRegexp("Web UI: http:\\/\\/localhost:[0-9]+\\/"))
|
|
}
|
|
})
|
|
|
|
It("should describe the API Server port (JSON)", func() {
|
|
args := []string{"describe", "component", "-o", "json"}
|
|
if podman {
|
|
args = append(args, "--platform", "podman")
|
|
}
|
|
stdout := helper.Cmd("odo", args...).ShouldPass().Out()
|
|
helper.IsJSON(stdout)
|
|
helper.JsonPathExist(stdout, "devControlPlane")
|
|
plt := "cluster"
|
|
if podman {
|
|
plt = "podman"
|
|
}
|
|
helper.JsonPathContentHasLen(stdout, "devControlPlane", 1)
|
|
helper.JsonPathContentIs(stdout, "devControlPlane.0.platform", plt)
|
|
if customPort {
|
|
helper.JsonPathContentIs(stdout, "devControlPlane.0.localPort", strconv.Itoa(localPort))
|
|
} else {
|
|
helper.JsonPathContentIsValidUserPort(stdout, "devControlPlane.0.localPort")
|
|
}
|
|
helper.JsonPathContentIs(stdout, "devControlPlane.0.apiServerPath", "/api/v1/")
|
|
helper.JsonPathContentIs(stdout, "devControlPlane.0.webInterfacePath", "/")
|
|
})
|
|
})
|
|
}
|
|
}))
|
|
|
|
When("the component is bootstrapped", helper.LabelPodmanIf(podman, func() {
|
|
BeforeEach(func() {
|
|
helper.CopyExample(filepath.Join("source", "devfiles", "nodejs", "project"), commonVar.Context)
|
|
helper.CopyExampleDevFile(filepath.Join("source", "devfiles", "nodejs", "devfile.yaml"), filepath.Join(commonVar.Context, "devfile.yaml"), cmpName)
|
|
})
|
|
When("odo dev is run with --api-server flag", func() {
|
|
var (
|
|
devSession helper.DevSession
|
|
)
|
|
BeforeEach(func() {
|
|
opts := helper.DevSessionOpts{
|
|
RunOnPodman: podman,
|
|
StartAPIServer: true,
|
|
}
|
|
var err error
|
|
devSession, err = helper.StartDevMode(opts)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
AfterEach(func() {
|
|
devSession.Stop()
|
|
devSession.WaitEnd()
|
|
})
|
|
It("should serve endpoints", func() {
|
|
By("GETting /instance", func() {
|
|
url := fmt.Sprintf("http://%s/instance", devSession.APIServerEndpoint)
|
|
resp, err := http.Get(url)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(resp.StatusCode).To(BeEquivalentTo(http.StatusOK))
|
|
defer resp.Body.Close()
|
|
body, err := io.ReadAll(resp.Body)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
strBody := string(body)
|
|
helper.JsonPathExist(strBody, "pid")
|
|
helper.JsonPathContentIs(strBody, "componentDirectory", commonVar.Context)
|
|
})
|
|
By("GETting /component", func() {
|
|
url := fmt.Sprintf("http://%s/component", devSession.APIServerEndpoint)
|
|
resp, err := http.Get(url)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(resp.StatusCode).To(BeEquivalentTo(http.StatusOK))
|
|
defer resp.Body.Close()
|
|
body, err := io.ReadAll(resp.Body)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
strBody := string(body)
|
|
helper.JsonPathContentIs(strBody, "devfilePath", filepath.Join(commonVar.Context, "devfile.yaml"))
|
|
helper.JsonPathContentIs(strBody, "devfileData.devfile.metadata.name", cmpName)
|
|
helper.JsonPathContentIs(strBody, "devfileData.supportedOdoFeatures.dev", "true")
|
|
helper.JsonPathContentIs(strBody, "devfileData.supportedOdoFeatures.deploy", "false")
|
|
helper.JsonPathContentIs(strBody, "devfileData.supportedOdoFeatures.debug", "false")
|
|
helper.JsonPathContentIs(strBody, "managedBy", "odo")
|
|
if podman {
|
|
helper.JsonPathDoesNotExist(strBody, "runningOn.cluster")
|
|
helper.JsonPathExist(strBody, "runningOn.podman")
|
|
helper.JsonPathContentIs(strBody, "runningOn.podman.dev", "true")
|
|
helper.JsonPathContentIs(strBody, "runningOn.podman.deploy", "false")
|
|
} else {
|
|
helper.JsonPathDoesNotExist(strBody, "runningOn.podman")
|
|
helper.JsonPathExist(strBody, "runningOn.cluster")
|
|
helper.JsonPathContentIs(strBody, "runningOn.cluster.dev", "true")
|
|
helper.JsonPathContentIs(strBody, "runningOn.cluster.deploy", "false")
|
|
}
|
|
})
|
|
})
|
|
|
|
When("/component/command endpoint is POSTed", func() {
|
|
BeforeEach(func() {
|
|
url := fmt.Sprintf("http://%s/component/command", devSession.APIServerEndpoint)
|
|
resp, err := http.Post(url, "application/json", bytes.NewBuffer([]byte(`{"name": "push"}`)))
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(resp.StatusCode).To(BeEquivalentTo(http.StatusOK))
|
|
})
|
|
|
|
It("should trigger a push", func() {
|
|
err := devSession.WaitSync()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
})
|
|
|
|
When("/instance endpoint is DELETEd", func() {
|
|
|
|
BeforeEach(func() {
|
|
url := fmt.Sprintf("http://%s/instance", devSession.APIServerEndpoint)
|
|
req, err := http.NewRequest(http.MethodDelete, url, bytes.NewBuffer([]byte{}))
|
|
Expect(err).ToNot(HaveOccurred())
|
|
client := &http.Client{}
|
|
resp, err := client.Do(req)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(resp.StatusCode).To(BeEquivalentTo(http.StatusOK))
|
|
})
|
|
|
|
It("should terminate the dev session", func() {
|
|
devSession.WaitEnd()
|
|
fmt.Println("<<< Session terminated >>>")
|
|
})
|
|
})
|
|
})
|
|
|
|
When("odo is executed with --no-watch and --api-server flags", helper.LabelPodmanIf(podman, func() {
|
|
|
|
var devSession helper.DevSession
|
|
|
|
BeforeEach(func() {
|
|
var err error
|
|
args := []string{"--no-watch"}
|
|
devSession, err = helper.StartDevMode(helper.DevSessionOpts{
|
|
CmdlineArgs: args,
|
|
RunOnPodman: podman,
|
|
StartAPIServer: true,
|
|
})
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
AfterEach(func() {
|
|
devSession.Stop()
|
|
devSession.WaitEnd()
|
|
})
|
|
|
|
When("a file in component directory is modified", func() {
|
|
|
|
BeforeEach(func() {
|
|
helper.ReplaceString(filepath.Join(commonVar.Context, "server.js"), "App started", "App is super started")
|
|
devSession.CheckNotSynced(10 * time.Second)
|
|
})
|
|
|
|
When("/component/command endpoint is POSTed", func() {
|
|
|
|
BeforeEach(func() {
|
|
url := fmt.Sprintf("http://%s/component/command", devSession.APIServerEndpoint)
|
|
resp, err := http.Post(url, "application/json", bytes.NewBuffer([]byte(`{"name": "push"}`)))
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(resp.StatusCode).To(BeEquivalentTo(http.StatusOK))
|
|
})
|
|
|
|
It("should trigger a push", func() {
|
|
err := devSession.WaitSync()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
component := helper.NewComponent(cmpName, "app", labels.ComponentDevMode, commonVar.Project, commonVar.CliRunner)
|
|
execResult, _ := component.Exec("runtime", []string{"cat", "/projects/server.js"}, pointer.Bool(true))
|
|
Expect(execResult).To(ContainSubstring("App is super started"))
|
|
})
|
|
})
|
|
})
|
|
}))
|
|
}))
|
|
}
|
|
})
|