aconfig: restrict valid namespace and flag names
The namespace and flag names will be used as identifiers in the
auto-generated code. Place restrictions on what constitutes a valid
name.
Valid identifiers are those that match /[a-z][a-z0-9_]/. aconfig
explicitly does not implement any automatic translation to make names
valid identifiers: this sidesteps potential conflicts such as "foo.bar"
and "foo_bar" mapping to the same name if dots were translated to
underscores.
Bug: b/284252015
Test: atest aconfig.test
Change-Id: I38d005a74311e5829e540063404d1565071e6e96
diff --git a/tools/aconfig/src/cache.rs b/tools/aconfig/src/cache.rs
index 30810fa..44ad3dd 100644
--- a/tools/aconfig/src/cache.rs
+++ b/tools/aconfig/src/cache.rs
@@ -19,6 +19,7 @@
use std::io::{Read, Write};
use crate::aconfig::{FlagDeclaration, FlagState, FlagValue, Permission};
+use crate::codegen;
use crate::commands::Source;
const DEFAULT_FLAG_STATE: FlagState = FlagState::Disabled;
@@ -108,7 +109,7 @@
impl CacheBuilder {
pub fn new(namespace: String) -> Result<CacheBuilder> {
- ensure!(!namespace.is_empty(), "empty namespace");
+ ensure!(codegen::is_valid_identifier(&namespace), "bad namespace");
let cache = Cache { namespace, items: vec![] };
Ok(CacheBuilder { cache })
}
@@ -118,7 +119,7 @@
source: Source,
declaration: FlagDeclaration,
) -> Result<&mut CacheBuilder> {
- ensure!(!declaration.name.is_empty(), "empty flag name");
+ ensure!(codegen::is_valid_identifier(&declaration.name), "bad flag name");
ensure!(!declaration.description.is_empty(), "empty flag description");
ensure!(
self.cache.items.iter().all(|item| item.name != declaration.name),
@@ -146,8 +147,8 @@
source: Source,
value: FlagValue,
) -> Result<&mut CacheBuilder> {
- ensure!(!value.namespace.is_empty(), "empty flag namespace");
- ensure!(!value.name.is_empty(), "empty flag name");
+ ensure!(codegen::is_valid_identifier(&value.namespace), "bad flag namespace");
+ ensure!(codegen::is_valid_identifier(&value.name), "bad flag name");
ensure!(
value.namespace == self.cache.namespace,
"failed to set values for flag {}/{} from {}: expected namespace {}",
@@ -270,14 +271,14 @@
.add_flag_value(
Source::Memory,
FlagValue {
- namespace: "some-other-namespace".to_string(),
+ namespace: "some_other_namespace".to_string(),
name: "foo".to_string(),
state: FlagState::Enabled,
permission: Permission::ReadOnly,
},
)
.unwrap_err();
- assert_eq!(&format!("{:?}", error), "failed to set values for flag some-other-namespace/foo from <memory>: expected namespace ns");
+ assert_eq!(&format!("{:?}", error), "failed to set values for flag some_other_namespace/foo from <memory>: expected namespace ns");
let cache = builder.build();
let item = cache.iter().find(|&item| item.name == "foo").unwrap();
@@ -300,7 +301,7 @@
FlagDeclaration { name: "".to_string(), description: "Description".to_string() },
)
.unwrap_err();
- assert_eq!(&format!("{:?}", error), "empty flag name");
+ assert_eq!(&format!("{:?}", error), "bad flag name");
let error = builder
.add_flag_declaration(
@@ -332,7 +333,7 @@
},
)
.unwrap_err();
- assert_eq!(&format!("{:?}", error), "empty flag namespace");
+ assert_eq!(&format!("{:?}", error), "bad flag namespace");
let error = builder
.add_flag_value(
@@ -345,7 +346,7 @@
},
)
.unwrap_err();
- assert_eq!(&format!("{:?}", error), "empty flag name");
+ assert_eq!(&format!("{:?}", error), "bad flag name");
}
#[test]