chore: Report an error in CLI if css-inline is built without the cli feature

Author: Stranger6667

.github/workflows/build.yml

@@ -219,6 +219,8 @@ jobs:
       - name: Install cargo-llvm-cov
         uses: taiki-e/install-action@cargo-llvm-cov
 
+      - uses: taiki-e/install-action@cargo-hack
+
       - uses: actions/setup-python@v4
         with:
           python-version: 3.7
@@ -229,8 +231,12 @@ jobs:
           # Starts the server in background
           python ./css-inline/tests/server.py &
 
-      - name: Generate code coverage
-        run: cargo llvm-cov --all-features --lcov --output-path lcov.info
+      - name: Run tests
+        run: cargo hack llvm-cov --no-report
+        working-directory: ./css-inline
+
+      - name: Generate coverage reports
+        run: cargo llvm-cov report --lcov --output-path lcov.info
         working-directory: ./css-inline
 
       - name: Upload coverage to Codecov

css-inline/src/lib.rs

@@ -293,7 +293,7 @@ impl<'a> CSSInliner<'a> {
     }
 }
 
-fn load_external(mut location: &str) -> Result<String> {
+fn load_external(location: &str) -> Result<String> {
     if location.starts_with("https") | location.starts_with("http") {
         #[cfg(feature = "http")]
         {
@@ -312,7 +312,7 @@ fn load_external(mut location: &str) -> Result<String> {
     } else {
         #[cfg(feature = "file")]
         {
-            location = location.trim_start_matches("file://");
+            let location = location.trim_start_matches("file://");
             std::fs::read_to_string(location).map_err(|error| match error.kind() {
                 ErrorKind::NotFound => InlineError::MissingStyleSheet {
                     path: location.to_string(),

css-inline/src/main.rs

@@ -1,21 +1,29 @@
-use css_inline::{CSSInliner, InlineOptions};
-use rayon::prelude::*;
-use std::{
-    borrow::Cow,
-    error::Error,
-    ffi::OsString,
-    fmt::{Display, Write as FmtWrite},
-    fs::{read_to_string, File},
-    io::{self, Read, Write},
-    path::Path,
-    sync::atomic::{AtomicI32, Ordering},
-};
+#[cfg(not(feature = "cli"))]
+fn main() {
+    eprintln!("`css-inline` CLI is only available with the `cli` feature");
+    std::process::exit(1);
+}
+
+#[cfg(feature = "cli")]
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    use css_inline::{CSSInliner, InlineOptions};
+    use rayon::prelude::*;
+    use std::{
+        borrow::Cow,
+        ffi::OsString,
+        fmt::{Display, Write as FmtWrite},
+        fs::{read_to_string, File},
+        io::{self, Read, Write},
+        path::Path,
+        sync::atomic::{AtomicI32, Ordering},
+    };
 
-const VERSION_MESSAGE: &[u8] = concat!("css-inline ", env!("CARGO_PKG_VERSION"), "\n").as_bytes();
-const HELP_MESSAGE: &[u8] = concat!(
-    "css-inline ",
-    env!("CARGO_PKG_VERSION"),
-    r#"
+    const VERSION_MESSAGE: &[u8] =
+        concat!("css-inline ", env!("CARGO_PKG_VERSION"), "\n").as_bytes();
+    const HELP_MESSAGE: &[u8] = concat!(
+        "css-inline ",
+        env!("CARGO_PKG_VERSION"),
+        r#"
 Dmitry Dygalo <[email protected]>
 
 css-inline inlines CSS into HTML documents.
@@ -50,37 +58,36 @@ OPTIONS:
     --output-filename-prefix
         Custom prefix for output files. Defaults to `inlined.`.
 "#
-)
-.as_bytes();
+    )
+    .as_bytes();
 
-struct Args {
-    keep_style_tags: bool,
-    base_url: Option<String>,
-    extra_css: Option<String>,
-    output_filename_prefix: Option<OsString>,
-    load_remote_stylesheets: bool,
-    files: Vec<String>,
-}
+    struct Args {
+        keep_style_tags: bool,
+        base_url: Option<String>,
+        extra_css: Option<String>,
+        output_filename_prefix: Option<OsString>,
+        load_remote_stylesheets: bool,
+        files: Vec<String>,
+    }
 
-fn parse_url(url: Option<String>) -> Result<Option<url::Url>, url::ParseError> {
-    Ok(if let Some(url) = url {
-        Some(url::Url::parse(url.as_str())?)
-    } else {
-        None
-    })
-}
+    fn parse_url(url: Option<String>) -> Result<Option<url::Url>, url::ParseError> {
+        Ok(if let Some(url) = url {
+            Some(url::Url::parse(url.as_str())?)
+        } else {
+            None
+        })
+    }
 
-fn format_error(filename: Option<&str>, error: impl Display) {
-    let mut buffer = String::with_capacity(128);
-    if let Some(filename) = filename {
-        writeln!(buffer, "Filename: {}", filename).expect("Failed to write to buffer");
+    fn format_error(filename: Option<&str>, error: impl Display) {
+        let mut buffer = String::with_capacity(128);
+        if let Some(filename) = filename {
+            writeln!(buffer, "Filename: {}", filename).expect("Failed to write to buffer");
+        }
+        buffer.push_str("Status: ERROR\n");
+        writeln!(buffer, "Details: {}", error).expect("Failed to write to buffer");
+        eprintln!("{}", buffer.trim());
     }
-    buffer.push_str("Status: ERROR\n");
-    writeln!(buffer, "Details: {}", error).expect("Failed to write to buffer");
-    eprintln!("{}", buffer.trim());
-}
 
-fn main() -> Result<(), Box<dyn Error>> {
     let mut args = pico_args::Arguments::from_env();
     let exit_code = AtomicI32::new(0);
     if args.contains(["-h", "--help"]) {

css-inline/tests/test_cli.rs

@@ -1,23 +1,27 @@
 use assert_cmd::Command;
-use std::fs;
-use test_case::test_case;
 
 fn css_inline() -> Command {
     Command::cargo_bin("css-inline").unwrap()
 }
 
-#[test]
-fn success() {
-    css_inline()
-        .arg("tests/example.html")
-        .arg("--output-filename-prefix=keep-style-tags.")
-        .assert()
-        .success()
-        .stdout("tests/example.html: SUCCESS\n");
-    let content = fs::read_to_string("tests/keep-style-tags.example.html").unwrap();
-    assert_eq!(
-        content,
-        "<html><head>\n    \
+#[cfg(feature = "cli")]
+pub mod tests {
+    use super::css_inline;
+    use std::fs;
+    use test_case::test_case;
+
+    #[test]
+    fn success() {
+        css_inline()
+            .arg("tests/example.html")
+            .arg("--output-filename-prefix=keep-style-tags.")
+            .assert()
+            .success()
+            .stdout("tests/example.html: SUCCESS\n");
+        let content = fs::read_to_string("tests/keep-style-tags.example.html").unwrap();
+        assert_eq!(
+            content,
+            "<html><head>\n    \
         \n    \
         \n    \
         \n\
@@ -26,80 +30,96 @@ fn success() {
         <a class=\"test-class\" href=\"https://example.com\" style=\"color: #ffffff;\">Test</a>\n\
         <h1 style=\"text-decoration: none;\">Test</h1>\n\n\n\
         </body></html>"
-    )
-}
+        )
+    }
 
-#[test]
-fn keep_style_tags() {
-    css_inline()
-        .arg("tests/example.html")
-        .arg("--keep-style-tags")
-        .assert()
-        .success()
-        .stdout("tests/example.html: SUCCESS\n");
-    let content = fs::read_to_string("tests/inlined.example.html").unwrap();
-    assert_eq!(
-        content,
-        "<html><head>\n    \n    \
+    #[test]
+    fn keep_style_tags() {
+        css_inline()
+            .arg("tests/example.html")
+            .arg("--keep-style-tags")
+            .assert()
+            .success()
+            .stdout("tests/example.html: SUCCESS\n");
+        let content = fs::read_to_string("tests/inlined.example.html").unwrap();
+        assert_eq!(
+            content,
+            "<html><head>\n    \n    \
         <style>\n        h1 {\n            text-decoration: none;\n        }\n    </style>\n    \
         <style>\n        .test-class {\n            color: #ffffff;\n        }\n\n        a {\n            color: #17bebb;\n        }\n    </style>\n\
         </head>\n\
         <body>\n\
         <a class=\"test-class\" href=\"https://example.com\" style=\"color: #ffffff;\">Test</a>\n\
         <h1 style=\"text-decoration: none;\">Test</h1>\n\n\n\
         </body></html>"
-    )
-}
+        )
+    }
 
-#[test]
-fn wrong_base_url() {
-    css_inline()
-        .arg("--base-url=https://:::::")
-        .write_stdin(r#"<html><head><title>Test</title><link href="external.css" rel="stylesheet" type="text/css"></head><body><h1>Hello world!</h1></body></html>"#)
-        .assert()
-        .failure()
-        .stderr("Status: ERROR\nDetails: empty host\n");
-}
+    #[test]
+    fn wrong_base_url() {
+        css_inline()
+            .arg("--base-url=https://:::::")
+            .write_stdin(r#"<html><head><title>Test</title><link href="external.css" rel="stylesheet" type="text/css"></head><body><h1>Hello world!</h1></body></html>"#)
+            .assert()
+            .failure()
+            .stderr("Status: ERROR\nDetails: empty host\n");
+    }
 
-#[test]
-fn not_found() {
-    css_inline().arg("unknown.html").assert().failure().stderr(
-        "Filename: unknown.html\nStatus: ERROR\nDetails: No such file or directory (os error 2)\n",
-    );
-}
+    #[test]
+    fn not_found() {
+        css_inline().arg("unknown.html").assert().failure().stderr(
+            "Filename: unknown.html\nStatus: ERROR\nDetails: No such file or directory (os error 2)\n",
+        );
+    }
 
-#[test]
-fn invalid_css() {
-    css_inline()
-        .write_stdin(r#"<html><head><title>Test</title><style>h1 {background-color: blue;}</style></head><body><h1 style="@wrong { color: ---}">Hello world!</h1></body></html>"#)
-        .assert()
-        .failure()
-        .stderr("Status: ERROR\nDetails: Invalid @ rule: wrong\n");
-}
+    #[test]
+    fn invalid_css() {
+        css_inline()
+            .write_stdin(r#"<html><head><title>Test</title><style>h1 {background-color: blue;}</style></head><body><h1 style="@wrong { color: ---}">Hello world!</h1></body></html>"#)
+            .assert()
+            .failure()
+            .stderr("Status: ERROR\nDetails: Invalid @ rule: wrong\n");
+    }
 
-#[test]
-fn invalid_css_in_file() {
-    css_inline()
-        .arg("tests/invalid-example.html")
-        .assert()
-        .failure()
-        .stderr(
-            "Filename: tests/invalid-example.html\nStatus: ERROR\nDetails: Invalid @ rule: wrong\n",
-        );
-}
+    #[test]
+    fn invalid_css_in_file() {
+        css_inline()
+            .arg("tests/invalid-example.html")
+            .assert()
+            .failure()
+            .stderr(
+                "Filename: tests/invalid-example.html\nStatus: ERROR\nDetails: Invalid @ rule: wrong\n",
+            );
+    }
 
-#[test]
-fn stdin() {
-    css_inline()
-        .write_stdin(r#"<html><head><title>Test</title><style>h1 {background-color: blue;}</style></head><body><h1>Hello world!</h1></body></html>"#)
-        .assert()
-        .success()
-        .stdout("<html><head><title>Test</title></head><body><h1 style=\"background-color: blue;\">Hello world!</h1></body></html>");
+    #[test]
+    fn stdin() {
+        css_inline()
+            .write_stdin(r#"<html><head><title>Test</title><style>h1 {background-color: blue;}</style></head><body><h1>Hello world!</h1></body></html>"#)
+            .assert()
+            .success()
+            .stdout("<html><head><title>Test</title></head><body><h1 style=\"background-color: blue;\">Hello world!</h1></body></html>");
+    }
+
+    #[test_case("--help", "css-inline inlines CSS into HTML documents.")]
+    #[test_case("--version", "css-inline 0.9.0")]
+    fn args(arg: &str, expected: &str) {
+        let stdout = css_inline().arg(arg).assert().success().to_string();
+        assert!(stdout.contains(expected), "{}", stdout);
+    }
 }
 
-#[test_case("--help", "css-inline inlines CSS into HTML documents.")]
-#[test_case("--version", "css-inline 0.9.0")]
-fn args(arg: &str, expected: &str) {
-    let stdout = css_inline().arg(arg).assert().success().to_string();
-    assert!(stdout.contains(expected), "{}", stdout);
+#[cfg(not(feature = "cli"))]
+pub mod tests {
+    use super::css_inline;
+
+    #[test]
+    fn test_no_cli_feature() {
+        let cmd = css_inline().assert().failure();
+        let stdout = &cmd.get_output().stderr;
+        assert_eq!(
+            stdout,
+            b"`css-inline` CLI is only available with the `cli` feature\n"
+        );
+    }
 }