[pkgfs] Rename `ctl/garbage` to `ctl/do-not-use-this-garbage`
Soft-deprecating and validating there are no unaccounted dependencies on
the existing `ctl/garbage` path.
Bug: 75919
Change-Id: I36f2ebbdf0822707b391e23f64e29e139d9de0f0
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/525761
Fuchsia-Auto-Submit: Viktar Donich <viktard@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
Reviewed-by: Zach Kirschenbaum <zkbaum@google.com>
diff --git a/src/sys/pkg/bin/pkgfs/pkgfs/ctl_directory.go b/src/sys/pkg/bin/pkgfs/pkgfs/ctl_directory.go
index 26f2c60..be44eb5 100644
--- a/src/sys/pkg/bin/pkgfs/pkgfs/ctl_directory.go
+++ b/src/sys/pkg/bin/pkgfs/pkgfs/ctl_directory.go
@@ -70,7 +70,7 @@
func (d *ctlDirectory) Unlink(path string) error {
// the "garbage" file is a special control file. When it is unlinked,
// we trigger garbage collection.
- if path == "garbage" {
+ if path == "do-not-use-this-garbage" {
if err := d.fs.GC(); err != nil {
log.Printf("unlink garbage: %s", err)
}
diff --git a/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs.go b/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs.go
index 609b97c..7961ab3 100644
--- a/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs.go
+++ b/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs.go
@@ -70,7 +70,7 @@
unsupportedDirectory: unsupportedDirectory("/ctl"),
fs: f,
dirs: map[string]fs.Directory{
- "garbage": unsupportedDirectory("/ctl/garbage"),
+ "do-not-use-this-garbage": unsupportedDirectory("/ctl/do-not-use-this-garbage"),
"validation": &validationDir{
unsupportedDirectory: unsupportedDirectory("/ctl/validation"),
fs: f,
diff --git a/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs_test.go b/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs_test.go
index 222064b..6ac9901 100644
--- a/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs_test.go
+++ b/src/sys/pkg/bin/pkgfs/pkgfs/pkgfs_test.go
@@ -522,7 +522,7 @@
if err != nil {
t.Fatal(err)
}
- want := []string{"garbage", "validation"}
+ want := []string{"do-not-use-this-garbage", "validation"}
sort.Strings(names)
sort.Strings(want)
@@ -760,16 +760,16 @@
return d.Unlink(path)
}
- // /pkgfs/garbage no longer exists
- if err := unlink("garbage"); err == nil {
+ // /pkgfs/do-not-use-this-garbage no longer exists
+ if err := unlink("do-not-use-this-garbage"); err == nil {
t.Fatal("expected error, got nil")
}
- // unlinking garbage triggers a GC but doesn't remove the file.
- if err := unlink("ctl/garbage"); err != nil {
+ // unlinking do-not-use-this-garbage triggers a GC but doesn't remove the file.
+ if err := unlink("ctl/do-not-use-this-garbage"); err != nil {
t.Fatal(err)
}
- if err := unlink("ctl/garbage"); err != nil {
+ if err := unlink("ctl/do-not-use-this-garbage"); err != nil {
t.Fatal(err)
}
}
diff --git a/src/sys/pkg/lib/fuchsia-pkg-testing/tests/gc_test.rs b/src/sys/pkg/lib/fuchsia-pkg-testing/tests/gc_test.rs
index 02e3600..e407b9b 100644
--- a/src/sys/pkg/lib/fuchsia-pkg-testing/tests/gc_test.rs
+++ b/src/sys/pkg/lib/fuchsia-pkg-testing/tests/gc_test.rs
@@ -79,7 +79,7 @@
assert_eq!(sorted(ls_simple(blobfs_dir.list_dir(".").unwrap()).unwrap()), expected_blobs);
// Trigger GC
- d.remove_dir("ctl/garbage").unwrap();
+ d.remove_dir("ctl/do-not-use-this-garbage").unwrap();
// pkg blobs are in blobfs no longer
let expected_blobs = sorted(
@@ -168,7 +168,7 @@
assert_eq!(sorted(ls_simple(blobfs_dir.list_dir(".").unwrap()).unwrap()), expected_blobs);
// Trigger GC
- d.remove_dir("ctl/garbage").unwrap();
+ d.remove_dir("ctl/do-not-use-this-garbage").unwrap();
// cached pkg blobs are in blobfs no longer
let expected_blobs = sorted(
diff --git a/src/sys/pkg/lib/pkgfs/src/control.rs b/src/sys/pkg/lib/pkgfs/src/control.rs
index bcbf2cd..3c00ed5 100644
--- a/src/sys/pkg/lib/pkgfs/src/control.rs
+++ b/src/sys/pkg/lib/pkgfs/src/control.rs
@@ -76,7 +76,7 @@
/// Performs a garbage collection
pub async fn gc(&self) -> Result<(), GcError> {
self.proxy
- .unlink2("garbage", UnlinkOptions::EMPTY)
+ .unlink2("do-not-use-this-garbage", UnlinkOptions::EMPTY)
.await
.map_err(GcError::Fidl)?
.map_err(|s| GcError::UnlinkError(Status::from_raw(s)))
@@ -109,7 +109,7 @@
fasync::Task::spawn(async move {
match stream.try_next().await.unwrap().unwrap() {
DirectoryRequest::Unlink2 { name, options: _, responder } => {
- assert_eq!(name, "garbage");
+ assert_eq!(name, "do-not-use-this-garbage");
responder.send(&mut Ok(())).unwrap();
}
other => panic!("unexpected request: {:?}", other),
diff --git a/src/sys/pkg/tests/pkg-cache/src/space.rs b/src/sys/pkg/tests/pkg-cache/src/space.rs
index cdd8b50..018cc49 100644
--- a/src/sys/pkg/tests/pkg-cache/src/space.rs
+++ b/src/sys/pkg/tests/pkg-cache/src/space.rs
@@ -80,7 +80,7 @@
}
fn garbage_path(&self) -> PathBuf {
- self.root.path().join("ctl/garbage")
+ self.root.path().join("ctl/do-not-use-this-garbage")
}
fn create_garbage(&self) {
