Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2bb714ed authored by Treehugger Robot's avatar Treehugger Robot Committed by Gerrit Code Review
Browse files

Merge changes from topic "aconfig-gen-device-config-files" 

* changes:
  aconfig: add create-device-config-sysprops command
  aconfig: add create-device-config-defaults command
  aconfig: add test utilities
  aconfig: cache.rs: remove unnecessary use statements
  aconfig: give commands ownership of all arguments
parents 52b65fef c31a6ff6

tools/aconfig/src/cache.rs

+0 −1
Original line number Diff line number Diff line
@@ -179,7 +179,6 @@ impl CacheBuilder { 
#[cfg(test)]

mod tests {

    use super::*;

    use crate::aconfig::{FlagState, Permission};



    #[test]

    fn test_add_flag_declaration() {

tools/aconfig/src/codegen_rust.rs

+1 −19
Original line number Diff line number Diff line
@@ -79,28 +79,10 @@ fn create_template_parsed_flag(namespace: &str, item: &Item) -> TemplateParsedFl 
#[cfg(test)]

mod tests {

    use super::*;

    use crate::commands::{create_cache, Input, Source};



    #[test]

    fn test_generate_rust_code() {

        let cache = create_cache(

            "test",

            vec![Input {

                source: Source::File("testdata/test.aconfig".to_string()),

                reader: Box::new(include_bytes!("../testdata/test.aconfig").as_slice()),

            }],

            vec![

                Input {

                    source: Source::File("testdata/first.values".to_string()),

                    reader: Box::new(include_bytes!("../testdata/first.values").as_slice()),

                },

                Input {

                    source: Source::File("testdata/test.aconfig".to_string()),

                    reader: Box::new(include_bytes!("../testdata/second.values").as_slice()),

                },

            ],

        )

        .unwrap();

        let cache = crate::test::create_cache();

        let generated = generate_rust_code(&cache).unwrap();

        assert_eq!("src/lib.rs", format!("{}", generated.path.display()));

        let expected = r#"

tools/aconfig/src/commands.rs

+86 −28
Original line number Diff line number Diff line
@@ -22,8 +22,8 @@ use std::fmt; 
use std::io::Read;

use std::path::PathBuf;



use crate::aconfig::{FlagDeclarations, FlagValue};

use crate::cache::{Cache, CacheBuilder};

use crate::aconfig::{FlagDeclarations, FlagState, FlagValue, Permission};

use crate::cache::{Cache, CacheBuilder, Item};

use crate::codegen_cpp::generate_cpp_code;

use crate::codegen_java::generate_java_code;

use crate::codegen_rust::generate_rust_code;
@@ -93,16 +93,52 @@ pub fn create_cache( 
    Ok(builder.build())

}



pub fn create_java_lib(cache: &Cache) -> Result<OutputFile> {

    generate_java_code(cache)

pub fn create_java_lib(cache: Cache) -> Result<OutputFile> {

    generate_java_code(&cache)

}



pub fn create_cpp_lib(cache: &Cache) -> Result<OutputFile> {

    generate_cpp_code(cache)

pub fn create_cpp_lib(cache: Cache) -> Result<OutputFile> {

    generate_cpp_code(&cache)

}



pub fn create_rust_lib(cache: &Cache) -> Result<OutputFile> {

    generate_rust_code(cache)

pub fn create_rust_lib(cache: Cache) -> Result<OutputFile> {

    generate_rust_code(&cache)

}



pub fn create_device_config_defaults(caches: Vec<Cache>) -> Result<Vec<u8>> {

    let mut output = Vec::new();

    for item in sort_and_iter_items(caches).filter(|item| item.permission == Permission::ReadWrite)

    {

        let line = format!(

            "{}/{}:{}\n",

            item.namespace,

            item.name,

            match item.state {

                FlagState::Enabled => "enabled",

                FlagState::Disabled => "disabled",

            }

        );

        output.extend_from_slice(line.as_bytes());

    }

    Ok(output)

}



pub fn create_device_config_sysprops(caches: Vec<Cache>) -> Result<Vec<u8>> {

    let mut output = Vec::new();

    for item in sort_and_iter_items(caches).filter(|item| item.permission == Permission::ReadWrite)

    {

        let line = format!(

            "persist.device_config.{}.{}={}\n",

            item.namespace,

            item.name,

            match item.state {

                FlagState::Enabled => "true",

                FlagState::Disabled => "false",

            }

        );

        output.extend_from_slice(line.as_bytes());

    }

    Ok(output)

}



#[derive(Copy, Clone, Debug, PartialEq, Eq, ValueEnum)]
@@ -112,29 +148,26 @@ pub enum DumpFormat { 
    Protobuf,

}



pub fn dump_cache(mut caches: Vec<Cache>, format: DumpFormat) -> Result<Vec<u8>> {

pub fn dump_cache(caches: Vec<Cache>, format: DumpFormat) -> Result<Vec<u8>> {

    let mut output = Vec::new();

    caches.sort_by_cached_key(|cache| cache.namespace().to_string());

    for cache in caches.into_iter() {

    match format {

        DumpFormat::Text => {

                let mut lines = vec![];

                for item in cache.iter() {

                    lines.push(format!(

            for item in sort_and_iter_items(caches) {

                let line = format!(

                    "{}/{}: {:?} {:?}\n",

                    item.namespace, item.name, item.state, item.permission

                    ));

                );

                output.extend_from_slice(line.as_bytes());

            }

                output.append(&mut lines.concat().into());

        }

        DumpFormat::Debug => {

                let mut lines = vec![];

                for item in cache.iter() {

                    lines.push(format!("{:#?}\n", item));

            for item in sort_and_iter_items(caches) {

                let line = format!("{:#?}\n", item);

                output.extend_from_slice(line.as_bytes());

            }

                output.append(&mut lines.concat().into());

        }

        DumpFormat::Protobuf => {

            for cache in sort_and_iter_caches(caches) {

                let parsed_flags: ProtoParsedFlags = cache.into();

                parsed_flags.write_to_vec(&mut output)?;

            }
@@ -143,6 +176,15 @@ pub fn dump_cache(mut caches: Vec<Cache>, format: DumpFormat) -> Result<Vec<u8>> 
    Ok(output)

}



fn sort_and_iter_items(caches: Vec<Cache>) -> impl Iterator<Item = Item> {

    sort_and_iter_caches(caches).flat_map(|cache| cache.into_iter())

}



fn sort_and_iter_caches(mut caches: Vec<Cache>) -> impl Iterator<Item = Cache> {

    caches.sort_by_cached_key(|cache| cache.namespace().to_string());

    caches.into_iter()

}



#[cfg(test)]

mod tests {

    use super::*;
@@ -202,6 +244,22 @@ mod tests { 
        assert_eq!(Permission::ReadOnly, item.permission);

    }



    #[test]

    fn test_create_device_config_defaults() {

        let caches = vec![crate::test::create_cache()];

        let bytes = create_device_config_defaults(caches).unwrap();

        let text = std::str::from_utf8(&bytes).unwrap();

        assert_eq!("test/disabled_rw:disabled\ntest/enabled_rw:enabled\n", text);

    }



    #[test]

    fn test_create_device_config_sysprops() {

        let caches = vec![crate::test::create_cache()];

        let bytes = create_device_config_sysprops(caches).unwrap();

        let text = std::str::from_utf8(&bytes).unwrap();

        assert_eq!("persist.device_config.test.disabled_rw=false\npersist.device_config.test.enabled_rw=true\n", text);

    }



    #[test]

    fn test_dump_text_format() {

        let caches = vec![create_test_cache_ns1()];

tools/aconfig/src/main.rs

+48 −9
Original line number Diff line number Diff line
@@ -33,6 +33,9 @@ mod codegen_rust; 
mod commands;

mod protos;



#[cfg(test)]

mod test;



use crate::cache::Cache;

use commands::{DumpFormat, Input, OutputFile, Source};
@@ -61,6 +64,16 @@ fn cli() -> Command { 
                .arg(Arg::new("cache").long("cache").required(true))

                .arg(Arg::new("out").long("out").required(true)),

        )

        .subcommand(

            Command::new("create-device-config-defaults")

                .arg(Arg::new("cache").long("cache").action(ArgAction::Append).required(true))

                .arg(Arg::new("out").long("out").default_value("-")),

        )

        .subcommand(

            Command::new("create-device-config-sysprops")

                .arg(Arg::new("cache").long("cache").action(ArgAction::Append).required(true))

                .arg(Arg::new("out").long("out").default_value("-")),

        )

        .subcommand(

            Command::new("dump")

                .arg(Arg::new("cache").long("cache").action(ArgAction::Append).required(true))
@@ -108,6 +121,15 @@ fn write_output_file_realtive_to_dir(root: &Path, output_file: &OutputFile) -> R 
    Ok(())

}



fn write_output_to_file_or_stdout(path: &str, data: &[u8]) -> Result<()> {

    if path == "-" {

        io::stdout().write_all(data)?;

    } else {

        fs::File::create(path)?.write_all(data)?;

    }

    Ok(())

}



fn main() -> Result<()> {

    let matches = cli().get_matches();

    match matches.subcommand() {
@@ -125,7 +147,7 @@ fn main() -> Result<()> { 
            let file = fs::File::open(path)?;

            let cache = Cache::read_from_reader(file)?;

            let dir = PathBuf::from(get_required_arg::<String>(sub_matches, "out")?);

            let generated_file = commands::create_java_lib(&cache)?;

            let generated_file = commands::create_java_lib(cache)?;

            write_output_file_realtive_to_dir(&dir, &generated_file)?;

        }

        Some(("create-cpp-lib", sub_matches)) => {
@@ -133,7 +155,7 @@ fn main() -> Result<()> { 
            let file = fs::File::open(path)?;

            let cache = Cache::read_from_reader(file)?;

            let dir = PathBuf::from(get_required_arg::<String>(sub_matches, "out")?);

            let generated_file = commands::create_cpp_lib(&cache)?;

            let generated_file = commands::create_cpp_lib(cache)?;

            write_output_file_realtive_to_dir(&dir, &generated_file)?;

        }

        Some(("create-rust-lib", sub_matches)) => {
@@ -141,9 +163,31 @@ fn main() -> Result<()> { 
            let file = fs::File::open(path)?;

            let cache = Cache::read_from_reader(file)?;

            let dir = PathBuf::from(get_required_arg::<String>(sub_matches, "out")?);

            let generated_file = commands::create_rust_lib(&cache)?;

            let generated_file = commands::create_rust_lib(cache)?;

            write_output_file_realtive_to_dir(&dir, &generated_file)?;

        }

        Some(("create-device-config-defaults", sub_matches)) => {

            let mut caches = Vec::new();

            for path in sub_matches.get_many::<String>("cache").unwrap_or_default() {

                let file = fs::File::open(path)?;

                let cache = Cache::read_from_reader(file)?;

                caches.push(cache);

            }

            let output = commands::create_device_config_defaults(caches)?;

            let path = get_required_arg::<String>(sub_matches, "out")?;

            write_output_to_file_or_stdout(path, &output)?;

        }

        Some(("create-device-config-sysprops", sub_matches)) => {

            let mut caches = Vec::new();

            for path in sub_matches.get_many::<String>("cache").unwrap_or_default() {

                let file = fs::File::open(path)?;

                let cache = Cache::read_from_reader(file)?;

                caches.push(cache);

            }

            let output = commands::create_device_config_sysprops(caches)?;

            let path = get_required_arg::<String>(sub_matches, "out")?;

            write_output_to_file_or_stdout(path, &output)?;

        }

        Some(("dump", sub_matches)) => {

            let mut caches = Vec::new();

            for path in sub_matches.get_many::<String>("cache").unwrap_or_default() {
@@ -154,12 +198,7 @@ fn main() -> Result<()> { 
            let format = get_required_arg::<DumpFormat>(sub_matches, "format")?;

            let output = commands::dump_cache(caches, *format)?;

            let path = get_required_arg::<String>(sub_matches, "out")?;

            let mut file: Box<dyn Write> = if *path == "-" {

                Box::new(io::stdout())

            } else {

                Box::new(fs::File::create(path)?)

            };

            file.write_all(&output)?;

            write_output_to_file_or_stdout(path, &output)?;

        }

        _ => unreachable!(),

    }

tools/aconfig/src/test.rs

0 → 100644
+45 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * 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.

 */



#[cfg(test)]

pub mod test_utils {

    use crate::cache::Cache;

    use crate::commands::{Input, Source};



    pub fn create_cache() -> Cache {

        crate::commands::create_cache(

            "test",

            vec![Input {

                source: Source::File("testdata/test.aconfig".to_string()),

                reader: Box::new(include_bytes!("../testdata/test.aconfig").as_slice()),

            }],

            vec![

                Input {

                    source: Source::File("testdata/first.values".to_string()),

                    reader: Box::new(include_bytes!("../testdata/first.values").as_slice()),

                },

                Input {

                    source: Source::File("testdata/test.aconfig".to_string()),

                    reader: Box::new(include_bytes!("../testdata/second.values").as_slice()),

                },

            ],

        )

        .unwrap()

    }

}



#[cfg(test)]

pub use test_utils::*;