-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cli): Migrate Pager Duty alert channel to API v2 (#585)
- Loading branch information
1 parent
7847d3b
commit 68be1ec
Showing
6 changed files
with
216 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| // | ||
| // Author:: Darren Murray (<[email protected]>) | ||
| // Copyright:: Copyright 2021, Lacework Inc. | ||
| // License:: Apache License, Version 2.0 | ||
| // | ||
| // 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 | ||
| // | ||
| // http://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 api | ||
|
|
||
| // GetPagerDutyApi gets a single PagerDuty alert channel matching the | ||
| // provided integration guid | ||
| func (svc *AlertChannelsService) GetPagerDutyApi(guid string) ( | ||
| response PagerDutyApiAlertChannelResponseV2, | ||
| err error, | ||
| ) { | ||
| err = svc.get(guid, &response) | ||
| return | ||
| } | ||
|
|
||
| // UpdatePagerDutyApi updates a single PagerDuty integration on the Lacework Server | ||
| func (svc *AlertChannelsService) UpdatePagerDutyApi(data AlertChannel) ( | ||
| response PagerDutyApiAlertChannelResponseV2, | ||
| err error, | ||
| ) { | ||
| err = svc.update(data.ID(), data, &response) | ||
| return | ||
| } | ||
|
|
||
| type PagerDutyApiAlertChannelResponseV2 struct { | ||
| Data PagerDutyApiAlertChannelV2 `json:"data"` | ||
| } | ||
|
|
||
| type PagerDutyApiAlertChannelV2 struct { | ||
| v2CommonIntegrationData | ||
| Data PagerDutyApiDataV2 `json:"data"` | ||
| } | ||
|
|
||
| type PagerDutyApiDataV2 struct { | ||
| IntegrationKey string `json:"apiIntgKey"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| // | ||
| // Author:: Darren Murray (<[email protected]>) | ||
| // Copyright:: Copyright 2021, Lacework Inc. | ||
| // License:: Apache License, Version 2.0 | ||
| // | ||
| // 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 | ||
| // | ||
| // http://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 api_test | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/lacework/go-sdk/api" | ||
| "github.com/lacework/go-sdk/internal/intgguid" | ||
| "github.com/lacework/go-sdk/internal/lacework" | ||
| ) | ||
|
|
||
| func TestAlertChannelsGetPagerDuty(t *testing.T) { | ||
| var ( | ||
| intgGUID = intgguid.New() | ||
| apiPath = fmt.Sprintf("AlertChannels/%s", intgGUID) | ||
| fakeServer = lacework.MockServer() | ||
| ) | ||
| fakeServer.UseApiV2() | ||
| fakeServer.MockToken("TOKEN") | ||
| defer fakeServer.Close() | ||
|
|
||
| fakeServer.MockAPI(apiPath, func(w http.ResponseWriter, r *http.Request) { | ||
| assert.Equal(t, "GET", r.Method, "GetPagerDutyApi() should be a GET method") | ||
| fmt.Fprintf(w, generateAlertChannelResponse(singlePagerDutyAlertChannel(intgGUID))) | ||
| }) | ||
|
|
||
| c, err := api.NewClient("test", | ||
| api.WithApiV2(), | ||
| api.WithToken("TOKEN"), | ||
| api.WithURL(fakeServer.URL()), | ||
| ) | ||
| assert.Nil(t, err) | ||
|
|
||
| response, err := c.V2.AlertChannels.GetPagerDutyApi(intgGUID) | ||
| if assert.NoError(t, err) { | ||
| assert.NotNil(t, response) | ||
| assert.Equal(t, intgGUID, response.Data.IntgGuid) | ||
| assert.Equal(t, "integration_name", response.Data.Name) | ||
| assert.True(t, response.Data.State.Ok) | ||
| assert.Equal(t, response.Data.Data.IntegrationKey, "1234abc8901abc567abc123abc78e012") | ||
| } | ||
| } | ||
|
|
||
| func TestAlertChannelPagerDutyUpdate(t *testing.T) { | ||
| var ( | ||
| intgGUID = intgguid.New() | ||
| apiPath = fmt.Sprintf("AlertChannels/%s", intgGUID) | ||
| fakeServer = lacework.MockServer() | ||
| ) | ||
| fakeServer.UseApiV2() | ||
| fakeServer.MockToken("TOKEN") | ||
| defer fakeServer.Close() | ||
|
|
||
| fakeServer.MockAPI(apiPath, func(w http.ResponseWriter, r *http.Request) { | ||
| assert.Equal(t, "PATCH", r.Method, "UpdatePagerDutyApi() should be a PATCH method") | ||
|
|
||
| if assert.NotNil(t, r.Body) { | ||
| body := httpBodySniffer(r) | ||
| assert.Contains(t, body, intgGUID, "INTG_GUID missing") | ||
| assert.Contains(t, body, "integration_name", "alert channel name is missing") | ||
| assert.Contains(t, body, "PagerDutyApi", "wrong alert channel type") | ||
| assert.Contains(t, body, "apiIntgKey\":\"1234abc8901abc567abc123abc78e012", "missing host url") | ||
| } | ||
|
|
||
| fmt.Fprintf(w, generateAlertChannelResponse(singlePagerDutyAlertChannel(intgGUID))) | ||
| }) | ||
|
|
||
| c, err := api.NewClient("test", | ||
| api.WithApiV2(), | ||
| api.WithToken("TOKEN"), | ||
| api.WithURL(fakeServer.URL()), | ||
| ) | ||
| assert.Nil(t, err) | ||
|
|
||
| pagerDutyAlertChan := api.NewAlertChannel("integration_name", | ||
| api.PagerDutyApiAlertChannelType, | ||
| api.PagerDutyApiDataV2{ | ||
| IntegrationKey: "1234abc8901abc567abc123abc78e012", | ||
| }, | ||
| ) | ||
| assert.Equal(t, "integration_name", pagerDutyAlertChan.Name, "PagerDuty alert channel name mismatch") | ||
| assert.Equal(t, "PagerDutyApi", pagerDutyAlertChan.Type, "a new PagerDuty alert channel should match its type") | ||
| assert.Equal(t, 1, pagerDutyAlertChan.Enabled, "a new PagerDuty alert channel should be enabled") | ||
| pagerDutyAlertChan.IntgGuid = intgGUID | ||
|
|
||
| response, err := c.V2.AlertChannels.UpdatePagerDutyApi(pagerDutyAlertChan) | ||
| if assert.NoError(t, err) { | ||
| assert.NotNil(t, response) | ||
| assert.Equal(t, intgGUID, response.Data.IntgGuid) | ||
| assert.True(t, response.Data.State.Ok) | ||
| assert.Equal(t, response.Data.Data.IntegrationKey, "1234abc8901abc567abc123abc78e012") | ||
| } | ||
| } | ||
|
|
||
| func singlePagerDutyAlertChannel(id string) string { | ||
| return fmt.Sprintf(` | ||
| { | ||
| "createdOrUpdatedBy": "[email protected]", | ||
| "createdOrUpdatedTime": "2021-06-01T18:10:40.745Z", | ||
| "data": { | ||
| "apiIntgKey": "1234abc8901abc567abc123abc78e012" | ||
| }, | ||
| "enabled": 1, | ||
| "intgGuid": %q, | ||
| "isOrg": 0, | ||
| "name": "integration_name", | ||
| "state": { | ||
| "details": {}, | ||
| "lastSuccessfulTime": 1627895573122, | ||
| "lastUpdatedTime": 1627895573122, | ||
| "ok": true | ||
| }, | ||
| "type": "PagerDutyApi" | ||
| } | ||
| `, id) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters