/* 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 https://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 webservice import ( "encoding/json" "io/ioutil" "net/http" "net/url" "testing" "time" "opendev.org/airship/airshipui/internal/configs" "opendev.org/airship/airshipui/testutil" "github.com/gorilla/websocket" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) const ( serverAddr string = "localhost:8080" testBaremetalHTML string = "../integrations/ctl/testdata/baremetal.html" testDocumentHTML string = "../integrations/ctl/testdata/document.html" // client messages initialize string = `{"type":"electron","component":"initialize"}` keepalive string = `{"type":"electron","component":"keepalive"}` unknownType string = `{"type":"fake_type","component":"initialize"}` unknownComponent string = `{"type":"electron","component":"fake_component"}` document string = `{"type":"airshipctl","component":"document","subcomponent":"getDefaults"}` baremetal string = `{"type":"airshipctl","component":"baremetal","subcomponent":"getDefaults"}` config string = `{"type":"airshipctl","component":"config","subcomponent":"getDefaults"}` ) func init() { go WebServer() } func TestClientInit(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() // simulate config provided by airshipui.json configs.UIConfig = testutil.DummyCompleteConfig() // get server response to "initialize" message from client response, err := getResponse(client, initialize) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.Electron, Component: configs.Initialize, IsAuthenticated: false, Dashboards: []configs.Cluster{ testutil.DummyClusterConfig(), }, Plugins: []configs.Plugin{ testutil.DummyPluginWithDashboardConfig(), testutil.DummyPluginNoDashboard(), }, Authentication: testutil.DummyAuthMethodConfig(), // don't fail on timestamp diff Timestamp: response.Timestamp, } assert.Equal(t, expected, response) } func TestClientInitNoAuth(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() // simulate config provided by airshipui.json configs.UIConfig = testutil.DummyConfigNoAuth() isAuthenticated = false response, err := getResponse(client, initialize) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.Electron, Component: configs.Initialize, // isAuthenticated should now be true in response IsAuthenticated: true, Dashboards: []configs.Cluster{ testutil.DummyClusterConfig(), }, Plugins: []configs.Plugin{ testutil.DummyPluginWithDashboardConfig(), testutil.DummyPluginNoDashboard(), }, // don't fail on timestamp diff Timestamp: response.Timestamp, } assert.Equal(t, expected, response) } func TestKeepalive(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() // get server response to "keepalive" message from client response, err := getResponse(client, keepalive) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.Electron, Component: configs.Keepalive, // don't fail on timestamp diff Timestamp: response.Timestamp, } assert.Equal(t, expected, response) } func TestUnknownType(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() response, err := getResponse(client, unknownType) require.NoError(t, err) expected := configs.WsMessage{ Type: "fake_type", Component: configs.Initialize, // don't fail on timestamp diff Timestamp: response.Timestamp, Error: "Requested type: fake_type, not found", } assert.Equal(t, expected, response) } func TestUnknownComponent(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() response, err := getResponse(client, unknownComponent) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.Electron, Component: "fake_component", // don't fail on timestamp diff Timestamp: response.Timestamp, Error: "Requested component: fake_component, not found", } assert.Equal(t, expected, response) } func TestHandleAuth(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() isAuthenticated = false // trigger web server's handleAuth function _, err = http.Get("http://localhost:8080/auth") require.NoError(t, err) var response configs.WsMessage err = client.ReadJSON(&response) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.Electron, Component: configs.Authcomplete, // don't fail on timestamp diff Timestamp: response.Timestamp, } // isAuthenticated should now be true after auth complete assert.Equal(t, isAuthenticated, true) assert.Equal(t, expected, response) } func TestHandleDocumentRequest(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() expectedHTML, err := ioutil.ReadFile(testDocumentHTML) require.NoError(t, err) response, err := getResponse(client, document) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.AirshipCTL, Component: configs.Document, SubComponent: configs.GetDefaults, HTML: string(expectedHTML), // don't fail on timestamp diff Timestamp: response.Timestamp, } assert.Equal(t, expected, response) } func TestHandleBaremetalRequest(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() expectedHTML, err := ioutil.ReadFile(testBaremetalHTML) require.NoError(t, err) response, err := getResponse(client, baremetal) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.AirshipCTL, Component: configs.Baremetal, SubComponent: configs.GetDefaults, HTML: string(expectedHTML), // don't fail on timestamp diff Timestamp: response.Timestamp, } assert.Equal(t, expected, response) } func TestHandleConfigRequest(t *testing.T) { client, err := NewTestClient() require.NoError(t, err) defer client.Close() response, err := getResponse(client, config) require.NoError(t, err) expected := configs.WsMessage{ Type: configs.AirshipCTL, Component: configs.CTLConfig, SubComponent: configs.GetDefaults, } assert.Equal(t, expected.Type, response.Type) assert.Equal(t, expected.Component, response.Component) assert.Equal(t, expected.SubComponent, response.SubComponent) // NOTE(mfuller): integrations/ctl 'client' gets initialized // *before* any env vars can be set here in tests, so client // will always be initialized with default config file locations. // Client is not exported, so we can't set it directly here. We'll // simply make sure there's no Error value and that HTML has // len > 0. Full testing of this response is covered in the // integrations/ctl tests. assert.Len(t, response.Error, 0) assert.Greater(t, len(response.HTML), 0) } func getResponse(client *websocket.Conn, message string) (configs.WsMessage, error) { err := client.WriteJSON(json.RawMessage(message)) if err != nil { return configs.WsMessage{}, err } var response configs.WsMessage err = client.ReadJSON(&response) if err != nil { return configs.WsMessage{}, err } return response, nil } func NewTestClient() (*websocket.Conn, error) { var err error var client *websocket.Conn u := url.URL{Scheme: "ws", Host: serverAddr, Path: "/ws"} // allow multiple attempts to establish websocket in case server isn't ready for i := 0; i < 5; i++ { client, _, err = websocket.DefaultDialer.Dial(u.String(), nil) if err == nil { return client, nil } time.Sleep(2 * time.Second) } return nil, err }