Rename README.md to Write

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,7 +13,7 @@ A clear and concise description of what the bug is. Please check the issue track
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Compile 'sudo-rs' '....'
-2. Write the following contents to `/etc/sudoers.test`  '....'
+2. Write the following contents to `/etc/sudoers-rs`  '....'
 3. Run the following command '....'
 4. See error
 

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -2,7 +2,7 @@
 A clear and concise description of the changes done by your pull request.
 
 **Pull Request Checklist**
-- [] I have read and accepted the [code of conduct](https://github.com/memorysafety/sudo-rs/blob/master/CODE_OF_CONDUCT.md) for this project.
+- [] I have read and accepted the [code of conduct](https://github.com/trifectatechfoundation/sudo-rs/blob/master/CODE_OF_CONDUCT.md) for this project.
 - [] I have tested, formatted and ran clippy over my changes.
 - [] I have commented and documented my changes.
-- [] This pull request will fix issue https://github.com/memorysafety/sudo-rs/issues/<#issue> where a proper discussion about a solution has taken place.
+- [] This pull request will fix issue https://github.com/trifectatechfoundation/sudo-rs/issues/<#issue> where a proper discussion about a solution has taken place.

.github/workflows/ci.yaml

@@ -12,6 +12,47 @@ on:
       - main
 
 jobs:
+  e2e-tests:
+    runs-on: ubuntu-latest
+    env:
+      SUDO_UNDER_TEST: ours
+      SUDO_TEST_VERBOSE_DOCKER_BUILD: 1
+      CI: true
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: set up docker buildx
+        run: docker buildx create --name builder --use
+
+      - name: cache docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: docker-buildx-rs-${{ github.sha }}
+          restore-keys: docker-buildx-rs-
+
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "compliance-tests"
+          workspaces: |
+            test-framework
+
+      - name: Run all E2E tests
+        working-directory: test-framework
+        run: cargo test -p e2e-tests
+
+      - name: prevent the cache from growing too large
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+
   compliance-tests-og:
     runs-on: ubuntu-latest
     env:
@@ -39,7 +80,7 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'compliance-tests'
+          shared-key: "compliance-tests"
           workspaces: |
             test-framework
 
@@ -58,7 +99,7 @@ jobs:
 
   compliance-tests:
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+    timeout-minutes: 20
     env:
       SUDO_TEST_PROFRAW_DIR: /tmp/profraw
       SUDO_TEST_VERBOSE_DOCKER_BUILD: 1
@@ -85,7 +126,7 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'compliance-tests'
+          shared-key: "compliance-tests"
           workspaces: |
             test-framework
 
@@ -95,14 +136,6 @@ jobs:
           SUDO_UNDER_TEST: ours
         run: cargo test -p sudo-compliance-tests
 
-      - name: Prepare code coverage data
-        run: ./make-lcov-info.bash
-
-      - name: Upload code coverage
-        uses: codecov/codecov-action@v3
-        with:
-          files: lcov.info
-
       - name: Check that we didn't forget to gate a passing compliance test
         working-directory: test-framework
         env:
@@ -132,24 +165,23 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'compliance-tests'
+          shared-key: "compliance-tests"
           workspaces: |
             test-framework
 
       - name: clippy sudo-test
         working-directory: test-framework
-        run: cargo clippy -p sudo-test --no-deps -- --deny clippy::all
+        run: cargo clippy -p sudo-test --no-deps -- --deny warnings
 
       - name: clippy compliance-tests
         working-directory: test-framework
-        run: cargo clippy -p sudo-compliance-tests --tests --no-deps -- --deny clippy::all
+        run: cargo clippy -p sudo-compliance-tests --tests --no-deps -- --deny warnings
 
       - name: Check that all ignored tests are linked to a GH issue
         working-directory: test-framework/sudo-compliance-tests
         run: |
           grep -r '#\[ignore' ./src | grep -v -e '"gh' -e '"wontfix"' && echo 'found ignored tests not linked to a GitHub issue. please like them using the format #[ignore = "gh123"]' && exit 1; true
 
-
   build-and-test:
     runs-on: ubuntu-latest
 
@@ -172,12 +204,12 @@ jobs:
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:
           packages: libpam0g-dev
-          version: 1.0
+          version: "1.0"
 
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'stable'
+          shared-key: "stable"
 
       - name: Build
         uses: actions-rs/cargo@v1
@@ -196,6 +228,86 @@ jobs:
         with:
           files: lcov.info
 
+  build-and-test-minimal:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set rust nightly version
+        run: echo "NIGHTLY_VERSION=$(curl https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/rustc)" >> $GITHUB_ENV
+
+      - name: Install rust
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly-${{ env.NIGHTLY_VERSION }}
+          override: true
+
+      - name: Install dependencies
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libpam0g-dev
+          version: "1.0"
+
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "nightly"
+
+      - name: Update to minimal direct dependencies
+        uses: actions-rs/cargo@v1
+        with:
+          command: update
+          args: -Zdirect-minimal-versions
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --workspace --all-targets --all-features --release
+
+      - name: Run tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --workspace --all-features --all-targets --release
+
+  build-and-test-msrv:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: "1.70"
+          override: true
+
+      - name: Install dependencies
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libpam0g-dev
+          version: "1.0"
+
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "msrv"
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --workspace --all-targets --all-features --release
+
+      - name: Run tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --workspace --all-features --all-targets --release
+
   miri:
     needs: build-and-test
     runs-on: ubuntu-latest
@@ -218,7 +330,7 @@ jobs:
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:
           packages: libpam0g-dev
-          version: 1.0
+          version: "1.0"
 
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
@@ -234,7 +346,7 @@ jobs:
   format:
     runs-on: ubuntu-latest
     env:
-      RUSTDOCFLAGS: '-D warnings'
+      RUSTDOCFLAGS: "-D warnings"
     steps:
       - uses: actions/checkout@v2
 
@@ -249,7 +361,7 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'stable'
+          shared-key: "stable"
 
       - name: Run rustfmt
         uses: actions-rs/cargo@v1
@@ -261,7 +373,7 @@ jobs:
     needs: format
     runs-on: ubuntu-latest
     env:
-      RUSTDOCFLAGS: '-D warnings'
+      RUSTDOCFLAGS: "-D warnings"
     steps:
       - uses: actions/checkout@v2
 
@@ -277,25 +389,21 @@ jobs:
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:
           packages: libpam0g-dev
-          version: 1.0
+          version: "1.0"
 
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'stable'
+          shared-key: "stable"
 
       - name: Run clippy
-        uses: actions-rs/clippy-check@v1
-        with:
-          name: clippy-result
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --no-deps
+        run: cargo clippy --no-deps --all-targets --all-features -- --deny warnings
 
   docs:
     needs: clippy
     runs-on: ubuntu-latest
     env:
-      RUSTDOCFLAGS: '-D warnings'
+      RUSTDOCFLAGS: "-D warnings"
     steps:
       - uses: actions/checkout@v2
 
@@ -310,67 +418,19 @@ jobs:
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:
           packages: libpam0g-dev
-          version: 1.0
+          version: "1.0"
 
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'stable'
+          shared-key: "stable"
 
       - name: Build docs
         uses: actions-rs/cargo@v1
         with:
           command: doc
           args: --no-deps --document-private-items --all-features
 
-  track-dependencies:
-    needs: clippy
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      pull-requests: write
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set rust nightly version
-        run: echo "NIGHTLY_VERSION=$(curl https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/rustc)" >> $GITHUB_ENV
-
-      - name: Install rust
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: nightly-${{ env.NIGHTLY_VERSION }}
-          override: true
-
-      - name: Install cargo-udeps
-        uses: taiki-e/install-action@v2
-        with:
-          tool: cargo-udeps
-
-      - name: Install dependencies
-        uses: awalsh128/cache-apt-pkgs-action@latest
-        with:
-          packages: libpam0g-dev
-          version: 1.0
-
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2
-        with:
-          shared-key: deps
-
-      - name: Check udeps
-        uses: actions-rs/cargo@v1
-        with:
-          command: udeps
-          args: --workspace --all-targets
-
-      - uses: tweedegolf/[email protected]
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          bin: sudo
-          mainBranchName: main
-
   audit:
     needs: clippy
     runs-on: ubuntu-latest
@@ -392,7 +452,7 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         with:
-          shared-key: 'audit'
+          shared-key: "audit"
 
       - name: Run audit
         uses: actions-rs/cargo@v1

.gitignore

@@ -8,3 +8,11 @@
 
 # Code coverage in lcov format
 /lcov.info
+
+# Generated man pages
+/docs/man/*.1
+/docs/man/*.1.gz
+/docs/man/*.5
+/docs/man/*.5.gz
+/docs/man/*.8
+/docs/man/*.8.gz