You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by "AbdelrahmanElawady (via GitHub)" <gi...@apache.org> on 2023/05/15 07:42:19 UTC
[GitHub] [trafficcontrol] AbdelrahmanElawady opened a new pull request, #7521: Return empty array instead of null when permissions are omitted
AbdelrahmanElawady opened a new pull request, #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521
<!--
Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
If this closes or relates to an existing issue, please reference it using one of the following:
Closes: #ISSUE
Related: #ISSUE
If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
Return empty array instead of null in when no permissions are given using POST and PUT requests to /roles endpoint
<!-- **^ Add meaningful description above** --><hr/>
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this PR.
Feel free to add the name of a tool or script that is affected but not on the list.
-->
- Traffic Ops
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your PR.
If your PR has tests (and most should), provide the steps needed to run the tests.
If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
using development environment:
- Login to Traffic Ops
- Make a POST request to /roles endpoint with empty permissions
- Make a PUT request to /roles with existing role with empty permissions
## If this is a bugfix, which Traffic Control versions contained the bug?
<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
Examples:
- 5.1.2
- 5.1.3 (RC1)
-->
## PR submission checklist
- [ ] This PR has tests <!-- If not, please delete this text and explain why this PR does not need tests. -->
- [x] This PR has documentation <!-- If not, please delete this text and explain why this PR does not need documentation. -->
- [ ] This PR has a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should have a changelog entry. -->
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://apache.org/security) for details)
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] codecov[bot] commented on pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521#issuecomment-1547384330
## [Codecov](https://app.codecov.io/gh/apache/trafficcontrol/pull/7521?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
> Merging [#7521](https://app.codecov.io/gh/apache/trafficcontrol/pull/7521?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (a6bb3ea) into [master](https://app.codecov.io/gh/apache/trafficcontrol/commit/b0d00b1901e9b49b9aee726302094d70996a49c7?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (b0d00b1) will **decrease** coverage by `0.01%`.
> The diff coverage is `0.00%`.
```diff
@@ Coverage Diff @@
## master #7521 +/- ##
============================================
- Coverage 30.17% 30.17% -0.01%
Complexity 98 98
============================================
Files 789 789
Lines 82299 82307 +8
Branches 815 815
============================================
Hits 24833 24833
- Misses 55387 55396 +9
+ Partials 2079 2078 -1
```
| Flag | Coverage Δ | |
|---|---|---|
| golib_unit | `48.58% <ø> (+<0.01%)` | :arrow_up: |
| grove_unit | `4.60% <ø> (ø)` | |
| t3c_unit | `5.32% <ø> (ø)` | |
| traffic_monitor_unit | `21.28% <ø> (ø)` | |
| traffic_ops_unit | `23.13% <0.00%> (-0.01%)` | :arrow_down: |
| traffic_portal_v2 | `76.06% <ø> (-0.03%)` | :arrow_down: |
| traffic_stats_unit | `10.14% <ø> (ø)` | |
| unit_tests | `27.23% <0.00%> (-0.01%)` | :arrow_down: |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
| [Impacted Files](https://app.codecov.io/gh/apache/trafficcontrol/pull/7521?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [traffic\_ops/traffic\_ops\_golang/role/roles.go](https://app.codecov.io/gh/apache/trafficcontrol/pull/7521?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-dHJhZmZpY19vcHMvdHJhZmZpY19vcHNfZ29sYW5nL3JvbGUvcm9sZXMuZ28=) | `7.31% <0.00%> (-0.12%)` | :arrow_down: |
... and [3 files with indirect coverage changes](https://app.codecov.io/gh/apache/trafficcontrol/pull/7521/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] AbdelrahmanElawady commented on pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "AbdelrahmanElawady (via GitHub)" <gi...@apache.org>.
AbdelrahmanElawady commented on PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521#issuecomment-1551686751
> You can still add tests for testing the roles body, that will just involve adding and checking separate GET request after the POST.
As mentioned in the issue the problem is with the immediate response from PUT and POST requests. Later GET requests have no problems and not changed in this PR. So how exactly separate GET requests could be used?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "zrhoffman (via GitHub)" <gi...@apache.org>.
zrhoffman commented on PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521#issuecomment-1551622459
> @ocket8888 I think with the current implementation of TO session for integration tests we can't get response body from roles endpoint for any request methods other than GET. https://github.com/apache/trafficcontrol/blob/master/traffic_ops/testing/api/v5/roles_test.go#L220-L247 I am not sure how exactly I could add tests in this case, any suggestion?
You can still add tests for testing the roles body, that will just involve adding and checking separate GET request after the POST.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman merged pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "zrhoffman (via GitHub)" <gi...@apache.org>.
zrhoffman merged PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] AbdelrahmanElawady commented on pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "AbdelrahmanElawady (via GitHub)" <gi...@apache.org>.
AbdelrahmanElawady commented on PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521#issuecomment-1548534639
@ocket8888 I think with the current implementation of TO session for integration tests we can't get response body from roles endpoint for any request methods other than GET.
https://github.com/apache/trafficcontrol/blob/master/traffic_ops/testing/api/v5/roles_test.go#L220-L247
I am not sure how exactly I could add tests in this case, any suggestion?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "zrhoffman (via GitHub)" <gi...@apache.org>.
zrhoffman commented on PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521#issuecomment-1551698848
> > You can still add tests for testing the roles body, that will just involve adding and checking separate GET request after the POST.
>
> As mentioned in the issue the problem is with the immediate response from PUT and POST requests. Later GET requests have no problems and not changed in this PR. So how exactly separate GET requests could be used?
Indeed, that approach won't help with test coverage here, and restructuring the TO client API library is an improvement outside the scope of this PR.
Rather than adding TO API tests for #7521, adding [unit tests](https://github.com/apache/trafficcontrol/blob/d022dd84c951/traffic_ops/traffic_ops_golang/role/roles_test.go) would be more appropriate.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "ocket8888 (via GitHub)" <gi...@apache.org>.
ocket8888 commented on PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521#issuecomment-1548284115
This PR should have a CHANGELOG entry and a test
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a diff in pull request #7521: Return empty array instead of null when permissions are omitted
Posted by "zrhoffman (via GitHub)" <gi...@apache.org>.
zrhoffman commented on code in PR #7521:
URL: https://github.com/apache/trafficcontrol/pull/7521#discussion_r1197011805
##########
traffic_ops/traffic_ops_golang/role/roles_test.go:
##########
@@ -20,15 +20,26 @@ package role
*/
import (
+ "context"
+ "encoding/json"
"errors"
+ "net/http"
+ "net/http/httptest"
"reflect"
"strings"
"testing"
+ "time"
"github.com/apache/trafficcontrol/lib/go-tc"
"github.com/apache/trafficcontrol/lib/go-util"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api"
+ "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/auth"
+ "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/config"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/test"
+ "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/trafficvault"
+ "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/trafficvault/backends/disabled"
+ "github.com/jmoiron/sqlx"
+ "gopkg.in/DATA-DOG/go-sqlmock.v1"
Review Comment:
3rd-party imports should be in a different import group
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org