api_test.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. package api
  2. import (
  3. "context"
  4. "testing"
  5. "connectrpc.com/connect"
  6. "github.com/stretchr/testify/assert"
  7. log "github.com/sirupsen/logrus"
  8. apiv1 "github.com/OliveTin/OliveTin/gen/olivetin/api/v1"
  9. apiv1connect "github.com/OliveTin/OliveTin/gen/olivetin/api/v1/apiv1connect"
  10. authpublic "github.com/OliveTin/OliveTin/internal/auth/authpublic"
  11. config "github.com/OliveTin/OliveTin/internal/config"
  12. "github.com/OliveTin/OliveTin/internal/entities"
  13. "github.com/OliveTin/OliveTin/internal/executor"
  14. "net/http"
  15. "net/http/httptest"
  16. "path"
  17. )
  18. func getNewTestServerAndClient(injectedConfig *config.Config) (*httptest.Server, apiv1connect.OliveTinApiServiceClient) {
  19. ex := executor.DefaultExecutor(injectedConfig)
  20. ex.RebuildActionMap()
  21. apiPath, apiHandler := GetNewHandler(ex)
  22. mux := http.NewServeMux()
  23. mux.Handle("/api/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  24. log.Infof("HTTP Request: %s %s", r.Method, r.URL.Path)
  25. // Translate /api/<service>/<method> to <service>/<method>
  26. fn := path.Base(r.URL.Path)
  27. r.URL.Path = apiPath + fn
  28. apiHandler.ServeHTTP(w, r)
  29. }))
  30. log.Infof("API path is %s", apiPath)
  31. httpclient := &http.Client{}
  32. ts := httptest.NewServer(mux)
  33. client := apiv1connect.NewOliveTinApiServiceClient(httpclient, ts.URL+"/api")
  34. log.Infof("Test server URL is %s", ts.URL+"/api"+apiPath)
  35. return ts, client
  36. }
  37. func TestGetActionsAndStart(t *testing.T) {
  38. cfg := config.DefaultConfig()
  39. btn1 := &config.Action{}
  40. btn1.Title = "blat"
  41. btn1.ID = "blat"
  42. btn1.Shell = "echo 'test'"
  43. cfg.Actions = append(cfg.Actions, btn1)
  44. ex := executor.DefaultExecutor(cfg)
  45. ex.RebuildActionMap()
  46. conn, client := getNewTestServerAndClient(cfg)
  47. respInit, errInit := client.Init(context.Background(), connect.NewRequest(&apiv1.InitRequest{}))
  48. respGetReady, errReady := client.GetReadyz(context.Background(), connect.NewRequest(&apiv1.GetReadyzRequest{}))
  49. if errInit != nil {
  50. t.Errorf("Init request failed: %v", errInit)
  51. return
  52. }
  53. if errReady != nil {
  54. t.Errorf("GetReadyz request failed: %v", errReady)
  55. return
  56. }
  57. log.Infof("GetReadyz response: %v", respGetReady.Msg)
  58. assert.Equal(t, true, true, "sayHello Failed")
  59. // assert.Equal(t, 1, len(respGb.Msg.Actions), "Got 1 action button back")
  60. log.Printf("Response: %+v", respInit)
  61. respSa, err := client.StartAction(context.Background(), connect.NewRequest(&apiv1.StartActionRequest{
  62. // ActionId: "blat"
  63. }))
  64. assert.NotNil(t, err, "Error 404 after start action")
  65. assert.Nil(t, respSa, "Nil response for non existing action")
  66. defer conn.Close()
  67. }
  68. func TestGetEntities(t *testing.T) {
  69. cfg := config.DefaultConfig()
  70. ts, client := getNewTestServerAndClient(cfg)
  71. defer ts.Close()
  72. setupTestEntities()
  73. resp, err := client.GetEntities(context.Background(), connect.NewRequest(&apiv1.GetEntitiesRequest{}))
  74. assert.NoError(t, err, "GetEntities should not return an error")
  75. assert.NotNil(t, resp, "GetEntities response should not be nil")
  76. assert.NotNil(t, resp.Msg, "GetEntities response message should not be nil")
  77. entityDefinitions := resp.Msg.EntityDefinitions
  78. assert.Equal(t, 3, len(entityDefinitions), "Should return 3 entity definitions")
  79. validateEntityOrderAndStructure(t, entityDefinitions)
  80. validateNoDuplicates(t, entityDefinitions)
  81. validateConsistency(t, client, entityDefinitions)
  82. }
  83. func setupTestEntities() {
  84. entities.ClearEntitiesOfType("server")
  85. entities.ClearEntitiesOfType("database")
  86. entities.ClearEntitiesOfType("application")
  87. entities.AddEntity("server", "zebra", map[string]any{"title": "Server Zebra", "hostname": "zebra.example.com"})
  88. entities.AddEntity("server", "alpha", map[string]any{"title": "Server Alpha", "hostname": "alpha.example.com"})
  89. entities.AddEntity("server", "beta", map[string]any{"title": "Server Beta", "hostname": "beta.example.com"})
  90. entities.AddEntity("database", "mysql", map[string]any{"title": "MySQL Database", "type": "mysql"})
  91. entities.AddEntity("database", "postgres", map[string]any{"title": "PostgreSQL Database", "type": "postgres"})
  92. entities.AddEntity("application", "webapp", map[string]any{"title": "Web Application", "port": 8080})
  93. }
  94. func validateEntityOrderAndStructure(t *testing.T, entityDefinitions []*apiv1.EntityDefinition) {
  95. assert.Equal(t, "application", entityDefinitions[0].Title, "First entity should be 'application' (alphabetically first)")
  96. assert.Equal(t, 1, len(entityDefinitions[0].Instances), "Application should have 1 instance")
  97. assert.Equal(t, "webapp", entityDefinitions[0].Instances[0].UniqueKey, "Application instance should be 'webapp'")
  98. assert.Equal(t, "database", entityDefinitions[1].Title, "Second entity should be 'database' (alphabetically second)")
  99. assert.Equal(t, 2, len(entityDefinitions[1].Instances), "Database should have 2 instances")
  100. assert.Equal(t, "mysql", entityDefinitions[1].Instances[0].UniqueKey, "First database instance should be 'mysql' (alphabetically first)")
  101. assert.Equal(t, "postgres", entityDefinitions[1].Instances[1].UniqueKey, "Second database instance should be 'postgres' (alphabetically second)")
  102. assert.Equal(t, "server", entityDefinitions[2].Title, "Third entity should be 'server' (alphabetically third)")
  103. assert.Equal(t, 3, len(entityDefinitions[2].Instances), "Server should have 3 instances")
  104. assert.Equal(t, "alpha", entityDefinitions[2].Instances[0].UniqueKey, "First server instance should be 'alpha' (alphabetically first)")
  105. assert.Equal(t, "beta", entityDefinitions[2].Instances[1].UniqueKey, "Second server instance should be 'beta' (alphabetically second)")
  106. assert.Equal(t, "zebra", entityDefinitions[2].Instances[2].UniqueKey, "Third server instance should be 'zebra' (alphabetically third)")
  107. }
  108. func validateNoDuplicates(t *testing.T, entityDefinitions []*apiv1.EntityDefinition) {
  109. instanceKeys := make(map[string]map[string]bool)
  110. for _, def := range entityDefinitions {
  111. instanceKeys[def.Title] = make(map[string]bool)
  112. for _, inst := range def.Instances {
  113. assert.False(t, instanceKeys[def.Title][inst.UniqueKey], "Instance key %s should not be duplicated in entity %s", inst.UniqueKey, def.Title)
  114. instanceKeys[def.Title][inst.UniqueKey] = true
  115. }
  116. }
  117. }
  118. func validateConsistency(t *testing.T, client apiv1connect.OliveTinApiServiceClient, entityDefinitions []*apiv1.EntityDefinition) {
  119. resp2, err2 := client.GetEntities(context.Background(), connect.NewRequest(&apiv1.GetEntitiesRequest{}))
  120. assert.NoError(t, err2, "Second GetEntities call should not return an error")
  121. assert.Equal(t, len(entityDefinitions), len(resp2.Msg.EntityDefinitions), "Second call should return same number of entity definitions")
  122. for i, def := range entityDefinitions {
  123. assert.Equal(t, def.Title, resp2.Msg.EntityDefinitions[i].Title, "Entity order should be consistent across calls")
  124. assert.Equal(t, len(def.Instances), len(resp2.Msg.EntityDefinitions[i].Instances), "Instance count should be consistent")
  125. for j, inst := range def.Instances {
  126. assert.Equal(t, inst.UniqueKey, resp2.Msg.EntityDefinitions[i].Instances[j].UniqueKey, "Instance order should be consistent across calls")
  127. }
  128. }
  129. }
  130. func TestEvaluateEnabledExpression(t *testing.T) {
  131. tests := []struct {
  132. name string
  133. expression string
  134. entity *entities.Entity
  135. expectedResult bool
  136. }{
  137. {
  138. name: "empty expression returns true",
  139. expression: "",
  140. entity: nil,
  141. expectedResult: true,
  142. },
  143. {
  144. name: "literal true returns true",
  145. expression: "true",
  146. entity: nil,
  147. expectedResult: true,
  148. },
  149. {
  150. name: "literal True returns true (case insensitive)",
  151. expression: "True",
  152. entity: nil,
  153. expectedResult: true,
  154. },
  155. {
  156. name: "literal 1 returns true",
  157. expression: "1",
  158. entity: nil,
  159. expectedResult: true,
  160. },
  161. {
  162. name: "literal false returns false",
  163. expression: "false",
  164. entity: nil,
  165. expectedResult: false,
  166. },
  167. {
  168. name: "literal 0 returns false",
  169. expression: "0",
  170. entity: nil,
  171. expectedResult: false,
  172. },
  173. {
  174. name: "empty result returns false",
  175. expression: "{{ .NonExistent }}",
  176. entity: nil,
  177. expectedResult: false,
  178. },
  179. {
  180. name: "expression with CurrentEntity true",
  181. expression: "{{ eq .CurrentEntity.powered_on true }}",
  182. entity: &entities.Entity{Data: map[string]any{"powered_on": true}},
  183. expectedResult: true,
  184. },
  185. {
  186. name: "expression with CurrentEntity false",
  187. expression: "{{ eq .CurrentEntity.powered_on true }}",
  188. entity: &entities.Entity{Data: map[string]any{"powered_on": false}},
  189. expectedResult: false,
  190. },
  191. {
  192. name: "expression with CurrentEntity integer 1",
  193. expression: "{{ .CurrentEntity.status }}",
  194. entity: &entities.Entity{Data: map[string]any{"status": 1}},
  195. expectedResult: true,
  196. },
  197. {
  198. name: "expression with CurrentEntity integer 0",
  199. expression: "{{ .CurrentEntity.status }}",
  200. entity: &entities.Entity{Data: map[string]any{"status": 0}},
  201. expectedResult: false,
  202. },
  203. {
  204. name: "template parse error returns false",
  205. expression: "{{ invalid syntax }}",
  206. entity: nil,
  207. expectedResult: false,
  208. },
  209. {
  210. name: "template exec error returns false",
  211. expression: "{{ .CurrentEntity.nonexistent }}",
  212. entity: nil,
  213. expectedResult: false,
  214. },
  215. }
  216. for _, tt := range tests {
  217. t.Run(tt.name, func(t *testing.T) {
  218. action := &config.Action{
  219. EnabledExpression: tt.expression,
  220. }
  221. result := evaluateEnabledExpression(action, tt.entity)
  222. assert.Equal(t, tt.expectedResult, result, "evaluateEnabledExpression should return expected result")
  223. })
  224. }
  225. }
  226. func TestBuildActionWithEnabledExpression(t *testing.T) {
  227. cfg := config.DefaultConfig()
  228. cfg.DefaultPermissions.Exec = true
  229. action := &config.Action{
  230. Title: "Test Action",
  231. Shell: "echo test",
  232. EnabledExpression: "{{ eq .CurrentEntity.enabled true }}",
  233. }
  234. cfg.Actions = append(cfg.Actions, action)
  235. ex := executor.DefaultExecutor(cfg)
  236. ex.RebuildActionMap()
  237. binding := findBindingByTitle(ex, "Test Action")
  238. assert.NotNil(t, binding, "Binding should be found")
  239. rr := &DashboardRenderRequest{
  240. AuthenticatedUser: &authpublic.AuthenticatedUser{Username: "testuser"},
  241. cfg: cfg,
  242. ex: ex,
  243. }
  244. testWithEntity(t, binding, rr, true, true, "Action should be executable when entity.enabled is true")
  245. testWithEntity(t, binding, rr, false, false, "Action should not be executable when entity.enabled is false")
  246. bindingNoExpr := findBindingByTitle(ex, "Test Action No Expression")
  247. if bindingNoExpr == nil {
  248. actionNoExpression := &config.Action{
  249. Title: "Test Action No Expression",
  250. Shell: "echo test",
  251. }
  252. cfg.Actions = append(cfg.Actions, actionNoExpression)
  253. ex.RebuildActionMap()
  254. bindingNoExpr = findBindingByTitle(ex, "Test Action No Expression")
  255. }
  256. actionResult := buildAction(bindingNoExpr, rr)
  257. assert.True(t, actionResult.CanExec, "Action without enabledExpression should be executable")
  258. }
  259. func findBindingByTitle(ex *executor.Executor, title string) *executor.ActionBinding {
  260. ex.MapActionBindingsLock.RLock()
  261. defer ex.MapActionBindingsLock.RUnlock()
  262. for _, b := range ex.MapActionBindings {
  263. if b.Action.Title == title {
  264. return b
  265. }
  266. }
  267. return nil
  268. }
  269. func testWithEntity(t *testing.T, binding *executor.ActionBinding, rr *DashboardRenderRequest, enabled bool, expectedCanExec bool, message string) {
  270. binding.Entity = &entities.Entity{
  271. UniqueKey: "test-entity",
  272. Data: map[string]any{"enabled": enabled},
  273. }
  274. actionResult := buildAction(binding, rr)
  275. assert.Equal(t, expectedCanExec, actionResult.CanExec, message)
  276. }