validation

Author: sdankel

docs/book/src/forc/manifest_reference.md

@@ -4,9 +4,14 @@ The `Forc.toml` (the _manifest_ file) is a compulsory file for each package and
 
 * [`[project]`](#the-project-section) — Defines a sway project.
   * `name` — The name of the project.
+  * `version` — The version of the project.
+  * `description` — A description of the project.
   * `authors` — The authors of the project.
   * `organization` — The organization of the project.
-  * `license`— The project license.
+  * `license` — The project license.
+  * `homepage` — URL of the project homepage.
+  * `repository` — URL of the project source repository.
+  * `documentation` — URL of the project documentation.
   * `entry` — The entry point for the compiler to start parsing from.
     * For the recommended way of selecting an entry point of large libraries please take a look at: [Libraries](./../sway-program-types/libraries.md)
   * `implicit-std` -  Controls whether provided `std` version (with the current `forc` version) will get added as a dependency _implicitly_. _Unless you know what you are doing, leave this as default._
@@ -29,6 +34,11 @@ An example `Forc.toml` is shown below. Under `[project]` the following fields ar
 
 * `authors`
 * `organization`
+* `version`
+* `description`
+* `homepage`
+* `repository`
+* `documentation`
 
 Also for the following fields, a default value is provided so omitting them is allowed:
 
@@ -39,6 +49,11 @@ Also for the following fields, a default value is provided so omitting them is a
 [project]
 authors = ["user"]
 entry = "main.sw"
+description = "Wallet contract"
+version = "1.0.0"
+homepage = "https://example.com/"
+repository = "https://example.com/"
+documentation = "https://example.com/"
 organization = "Fuel_Labs"
 license = "Apache-2.0"
 name = "wallet_contract"

forc-pkg/src/manifest/mod.rs

@@ -3,8 +3,8 @@ pub mod build_profile;
 use crate::pkg::{manifest_file_missing, parsing_failed, wrong_program_type};
 use anyhow::{anyhow, bail, Context, Result};
 use forc_tracing::println_warning;
-use forc_util::{validate_name, validate_project_name};
-use serde::{Deserialize, Serialize};
+use forc_util::{restricted::is_valid_package_version, validate_name, validate_project_name};
+use serde::{de, Deserialize, Serialize};
 use serde_with::{serde_as, DisplayFromStr};
 use std::{
     collections::{BTreeMap, HashMap},
@@ -19,6 +19,7 @@ use sway_utils::{
     constants, find_nested_manifest_dir, find_parent_manifest_dir,
     find_parent_manifest_dir_with_check,
 };
+use url::Url;
 
 use self::build_profile::BuildProfile;
 
@@ -193,14 +194,16 @@ pub struct PackageManifest {
 #[serde(rename_all = "kebab-case")]
 pub struct Project {
     pub authors: Option<Vec<String>>,
+    #[serde(deserialize_with = "validate_package_name")]
     pub name: String,
+    #[serde(deserialize_with = "validate_package_version")]
     pub version: Option<String>,
     pub description: Option<String>,
     pub organization: Option<String>,
     pub license: String,
-    pub homepage: Option<String>,
-    pub repository: Option<String>,
-    pub documentation: Option<String>,
+    pub homepage: Option<Url>,
+    pub repository: Option<Url>,
+    pub documentation: Option<Url>,
     #[serde(default = "default_entry")]
     pub entry: String,
     pub implicit_std: Option<bool>,
@@ -210,6 +213,35 @@ pub struct Project {
     pub metadata: Option<toml::Value>,
 }
 
+// Validation function for the `name` field
+fn validate_package_name<'de, D>(deserializer: D) -> Result<String, D::Error>
+where
+    D: de::Deserializer<'de>,
+{
+    let name: String = Deserialize::deserialize(deserializer)?;
+    match validate_project_name(&name) {
+        Ok(_) => Ok(name),
+        Err(e) => Err(de::Error::custom(e.to_string())),
+    }
+}
+
+// Validation function for `version`
+fn validate_package_version<'de, D>(deserializer: D) -> Result<Option<String>, D::Error>
+where
+    D: de::Deserializer<'de>,
+{
+    let version: Option<String> = Deserialize::deserialize(deserializer)?;
+    if let Some(ref version_str) = version {
+        if is_valid_package_version(version_str) {
+            return Err(de::Error::custom(format!(
+                "Invalid semantic version: '{}'",
+                version_str
+            )));
+        }
+    }
+    Ok(version)
+}
+
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
 #[serde(rename_all = "kebab-case")]
 pub struct Network {
@@ -1394,9 +1426,9 @@ mod tests {
             name: "test-project".to_string(),
             version: Some("0.1.0".to_string()),
             description: Some("test description".to_string()),
-            homepage: Some("https://example.com".to_string()),
-            documentation: Some("https://docs.example.com".to_string()),
-            repository: Some("https://example.com".to_string()),
+            homepage: Some(Url::parse("https://example.com").unwrap()),
+            documentation: Some(Url::parse("https://docs.example.com").unwrap()),
+            repository: Some(Url::parse("https://example.com").unwrap()),
             organization: None,
             license: "Apache-2.0".to_string(),
             entry: "main.sw".to_string(),

forc-util/src/restricted.rs

@@ -107,6 +107,12 @@ pub fn is_valid_project_name_format(name: &str) -> Result<()> {
     Ok(())
 }
 
+pub fn is_valid_package_version(vers: &str) -> bool {
+    // Must start with an alphanumeric character, can contain only letters, numbers, underscores, dots and hyphens
+    let re = Regex::new(r"^[a-zA-Z0-9][\w.-]*$").unwrap();
+    re.is_match(vers)
+}
+
 #[test]
 fn test_invalid_char() {
     assert_eq!(