Codegen enums from IANA registries

crates/iana-codegen/src/main.rs

@@ -0,0 +1,219 @@
+// Copyright 2022 The Matrix.org Foundation C.I.C.
+//
+// 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.
+
+use std::{collections::HashMap, fmt::Display, path::PathBuf, sync::Arc};
+
+use reqwest::Client;
+use tokio::io::AsyncWriteExt;
+use tracing::Level;
+
+pub mod jose;
+pub mod oauth;
+pub mod traits;
+
+#[derive(Debug)]
+struct File {
+    client: Arc<Client>,
+    registry_name: &'static str,
+    registry_url: &'static str,
+    sections: Vec<&'static str>,
+    sources: Vec<&'static str>,
+    items: HashMap<&'static str, Vec<EnumMember>>,
+}
+
+fn resolve_path(relative: PathBuf) -> PathBuf {
+    let crate_root = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+    let workspace_root = crate_root.parent().unwrap().parent().unwrap();
+    workspace_root.join(relative)
+}
+
+impl File {
+    #[tracing::instrument(skip(client))]
+    fn new(registry_name: &'static str, registry_url: &'static str, client: Arc<Client>) -> Self {
+        tracing::info!("Generating file from IANA registry");
+        Self {
+            client,
+            registry_name,
+            registry_url,
+            sources: Vec::new(),
+            sections: Vec::new(),
+            items: HashMap::new(),
+        }
+    }
+
+    #[tracing::instrument(skip_all, fields(url))]
+    async fn load<T: EnumEntry>(mut self) -> anyhow::Result<Self> {
+        tracing::Span::current().record("url", &T::URL);
+        self.sections.extend_from_slice(T::SECTIONS);
+        self.sources.push(T::URL);
+        for (key, value) in T::fetch(&self.client).await? {
+            self.items.entry(key).or_default().push(value);
+        }
+        Ok(self)
+    }
+
+    #[tracing::instrument(skip_all)]
+    async fn write(&self, path: PathBuf) -> anyhow::Result<()> {
+        let mut file = tokio::fs::OpenOptions::new()
+            .create(true)
+            .truncate(true)
+            .write(true)
+            .open(path)
+            .await?;
+
+        tracing::info!("Writing file");
+        file.write_all(format!("{}", self).as_bytes()).await?;
+
+        Ok(())
+    }
+}
+
+impl Display for File {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        writeln!(
+            f,
+            r#"// Copyright 2022 The Matrix.org Foundation C.I.C.
+//
+// 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.
+
+//! Enums from the {:?} IANA registry
+//! See <{}>
+//!
+//! Generated from:"#,
+            self.registry_name, self.registry_url,
+        )?;
+
+        for source in &self.sources {
+            writeln!(f, "//!  - <{}>", source)?;
+        }
+
+        writeln!(
+            f,
+            r#"
+// Do not edit this file manually
+
+use schemars::JsonSchema;
+use serde::{{Deserialize, Serialize}};
+"#
+        )?;
+
+        for key in &self.sections {
+            let list = if let Some(list) = self.items.get(key) {
+                list
+            } else {
+                continue;
+            };
+
+            writeln!(
+                f,
+                "#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)]"
+            )?;
+            write!(f, "pub enum {} {{", key)?;
+            for member in list {
+                writeln!(f)?;
+                if let Some(description) = &member.description {
+                    writeln!(f, "    /// {}", description)?;
+                }
+                writeln!(f, "    #[serde(rename = \"{}\")]", member.value)?;
+                writeln!(f, "    {},", member.enum_name)?;
+            }
+            writeln!(f, "}}")?;
+            writeln!(f)?;
+        }
+
+        Ok(())
+    }
+}
+
+use self::{jose::*, oauth::*, traits::*};
+
+#[tracing::instrument(skip(client))]
+async fn generate_jose(client: &Arc<Client>, path: PathBuf) -> anyhow::Result<()> {
+    let path = resolve_path(path);
+    let client = client.clone();
+
+    let file = File::new(
+        "JSON Object Signing and Encryption",
+        "https://www.iana.org/assignments/jose/jose.xhtml",
+        client.clone(),
+    )
+    .load::<WebEncryptionSignatureAlgorithm>()
+    .await?
+    .load::<WebEncryptionCompressionAlgorithm>()
+    .await?
+    .load::<WebKeyType>()
+    .await?
+    .load::<WebKeyEllipticCurve>()
+    .await?
+    .load::<WebKeyUse>()
+    .await?
+    .load::<WebKeyOperation>()
+    .await?;
+
+    file.write(path).await?;
+
+    Ok(())
+}
+
+#[tracing::instrument(skip(client))]
+async fn generate_oauth(client: &Arc<Client>, path: PathBuf) -> anyhow::Result<()> {
+    let path = resolve_path(path);
+    let client = client.clone();
+
+    let file = File::new(
+        "OAuth Parameters",
+        "https://www.iana.org/assignments/jose/jose.xhtml",
+        client.clone(),
+    )
+    .load::<TokenTypeHint>()
+    .await?
+    .load::<AuthorizationEndpointResponseType>()
+    .await?
+    .load::<TokenEndpointAuthenticationMethod>()
+    .await?
+    .load::<PkceCodeChallengeMethod>()
+    .await?;
+
+    file.write(path).await?;
+
+    Ok(())
+}
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    tracing_subscriber::fmt()
+        .with_max_level(Level::INFO)
+        .pretty()
+        .init();
+
+    let client = Client::builder().user_agent("iana-parser/0.0.1").build()?;
+    let client = Arc::new(client);
+
+    let iana_crate_root = PathBuf::from("crates/iana/");
+
+    generate_jose(&client, iana_crate_root.join("src/jose.rs")).await?;
+    generate_oauth(&client, iana_crate_root.join("src/oauth.rs")).await?;
+
+    Ok(())
+}