Skip to content

Ensure imports have explicit access levels #2192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/soundness.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,17 @@ jobs:
- name: Run soundness checks
run: |
./dev/check-generated-code.sh

check-imports:
name: Check imports have access level
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Mark the workspace as safe
run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
- name: Check import access level
run: |
./dev/check-imports.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

import Synchronization
private import Synchronization

extension ServerContext {
@TaskLocal
Expand Down
6 changes: 3 additions & 3 deletions Sources/GRPCInProcessTransport/Syscalls.swift
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
*/

#if canImport(Darwin)
import Darwin
private import Darwin
#elseif canImport(Glibc)
import Glibc
private import Glibc
#elseif canImport(Musl)
import Musl
private import Musl
#endif

enum System {
Expand Down
29 changes: 29 additions & 0 deletions dev/check-imports.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/bin/bash
## Copyright 2025, gRPC Authors All rights reserved.
##
## 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.

set -euo pipefail

log() { printf -- "** %s\n" "$*" >&2; }

here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
root="${here}/.."

log "Checking all imports have an access level"
if grep -r "^import " --exclude-dir="Documentation.docc" "${root}/Sources"; then
# Matches are bad!
exit 1
else
exit 0
fi
Loading