Viết quy tắc trên Windows

Báo cáo sự cố Xem nguồn

Trang này tập trung vào việc viết các quy tắc tương thích với Windows, các vấn đề thường gặp khi viết các quy tắc di động và một số giải pháp.

Đường dẫn

Vấn đề:

  • Giới hạn độ dài: độ dài đường dẫn tối đa là 259 ký tự.

    Mặc dù Windows cũng hỗ trợ các đường dẫn dài hơn (tối đa 32767 ký tự), nhưng nhiều chương trình được xây dựng với giới hạn dưới.

    Hãy lưu ý điều này về các chương trình bạn chạy trong hành động.

  • Thư mục hoạt động: cũng giới hạn trong 259 ký tự.

    Các quy trình không được cd vào thư mục dài hơn 259 ký tự.

  • Phân biệt chữ hoa chữ thường: Đường dẫn Windows không phân biệt chữ hoa chữ thường, đường dẫn Unix có phân biệt chữ hoa chữ thường.

    Hãy lưu ý điều này khi tạo dòng lệnh cho các thao tác.

  • Dấu phân cách đường dẫn: là dấu gạch chéo ngược (\`), not forward slash (/`).

    Bazel lưu trữ các đường dẫn kiểu Unix bằng dòng phân cách /. Mặc dù một số chương trình Windows hỗ trợ đường dẫn kiểu Unix, nhưng các chương trình khác thì không. Một số lệnh tích hợp trong cmd.exe hỗ trợ các lệnh này, một số lệnh không hỗ trợ.

    Tốt nhất là bạn nên luôn sử dụng \` separators on Windows: replace/with` khi tạo dòng lệnh và biến môi trường cho các hành động.

  • Đường dẫn tuyệt đối: không bắt đầu bằng dấu gạch chéo (/).

    Đường dẫn tuyệt đối trên Windows bắt đầu bằng một tên ổ đĩa, chẳng hạn như C:\foo\bar.txt. Không có thư mục gốc duy nhất của hệ thống tệp.

    Hãy lưu ý điều này nếu quy tắc của bạn kiểm tra xem một đường dẫn có tuyệt đối hay không. Bạn nên tránh sử dụng đường dẫn tuyệt đối vì chúng thường không di động được.

Giải pháp:

  • Đảm bảo đường dẫn ngắn gọn.

    Tránh dùng tên thư mục dài, cấu trúc thư mục lồng sâu, tên tệp dài, tên không gian làm việc dài, tên mục tiêu dài.

    Tất cả các đối tượng này có thể trở thành thành phần đường dẫn của tệp đầu vào của thao tác và có thể sử dụng hết giới hạn độ dài đường dẫn.

  • Sử dụng gốc đầu ra ngắn.

    Sử dụng cờ --output_user_root=<path> để chỉ định một đường dẫn ngắn cho đầu ra Bazel. Bạn nên có một ổ đĩa (hoặc ổ ảo) chỉ cho các đầu ra Bazel (chẳng hạn như tệp D:\`), and adding this line to your.bazelrc`:

    build --output_user_root=D:/

    hoặc

    build --output_user_root=C:/_bzl

  • Sử dụng đường giao nhau.

    Nói một cách đơn giản[1], bạn có thể thấy các nút nối là đường liên kết tượng trưng trong thư mục. Các điểm nối rất dễ tạo và có thể trỏ đến các thư mục (trên cùng một máy tính) có đường dẫn dài. Nếu một thao tác tạo bản dựng tạo ra một nút giao có đường dẫn ngắn nhưng mục tiêu dài, thì các công cụ có giới hạn đường dẫn ngắn có thể truy cập vào các tệp trong thư mục liên kết.

    Trong tệp .bat hoặc trong cmd.exe, bạn có thể tạo các mối liên kết như sau:

    mklink /J c:\path\to\junction c:\path\to\very\long\target\path

    [1]: Nói một cách chính xác, Nút giao không phải là Đường liên kết tượng trưng, nhưng để thực hiện các thao tác xây dựng, bạn có thể coi các Nút này là Đường liên kết tượng trưng trong thư mục.

  • Thay thế / bằng "" trong các đường dẫn trong hành động / envvars.

    Khi bạn tạo dòng lệnh hoặc biến môi trường cho một thao tác, hãy tạo đường dẫn theo kiểu Windows. Ví dụ:

    def as_path(p, is_windows):
    if is_windows:
        return p.replace("/", "\\")
    else:
        return p

Biến môi trường

Vấn đề:

  • Phân biệt chữ hoa chữ thường: Các tên biến môi trường trong Windows không phân biệt chữ hoa chữ thường.

    Ví dụ: trong Java, System.getenv("SystemRoot") và System.getenv("SYSTEMROOT") đều trả về cùng một kết quả. (Điều này cũng áp dụng cho các ngôn ngữ khác.)

  • Độ ẩm: các hành động nên sử dụng ít biến môi trường tuỳ chỉnh nhất có thể.

    Biến môi trường là một phần của khoá bộ nhớ đệm của thao tác. Nếu một thao tác sử dụng các biến môi trường thường xuyên thay đổi hoặc được tuỳ chỉnh cho người dùng, thì khả năng lưu vào bộ nhớ đệm của quy tắc sẽ giảm đi.

Giải pháp:

  • Chỉ sử dụng tên biến môi trường được viết hoa.

    Tính năng này hoạt động trên Windows, macOS và Linux.

  • Giảm thiểu các môi trường hành động.

    Khi sử dụng ctx.actions.run, hãy đặt môi trường thành ctx.configuration.default_shell_env. Nếu thao tác cần thêm biến môi trường, hãy đưa tất cả các biến đó vào một từ điển và truyền biến đó vào thao tác. Ví dụ:

    load("@bazel_skylib//lib:dicts.bzl", "dicts")

def _make_env(ctx, output_file, is_windows):
    out_path = output_file.path
    if is_windows:
        out_path = out_path.replace("/", "\\")
    return dicts.add(ctx.configuration.default_shell_env, {"MY_OUTPUT": out_path})

Thao tác

Vấn đề:

  • Đầu ra có thể thực thi: Mọi tệp thực thi phải có một đuôi có thể thực thi.

    Các đuôi phổ biến nhất là .exe (tệp nhị phân) và .bat (Tập lệnh theo lô).

    Lưu ý rằng các tập lệnh shell (.sh) KHÔNG thực thi được trên Windows; bạn không thể chỉ định chúng làm executable của ctx.actions.run. Các tệp cũng không có quyền +x. Vì vậy, bạn không thể thực thi các tệp tuỳ ý như trên Linux.

  • Lệnh Bash: Để đảm bảo tính dễ di chuyển, bạn nên tránh chạy lệnh Bash ngay trong hành động.

    Bash phổ biến trên các hệ thống giống như Unix nhưng thường không có trên Windows. Bản thân Bazel ngày càng phụ thuộc vào Bash (MSYS2), vì vậy, trong tương lai, người dùng có thể sẽ ít cài đặt MSYS2 cùng với Bazel hơn. Để dễ sử dụng các quy tắc trên Windows hơn, hãy tránh chạy các lệnh Bash trong hành động.

  • Phần cuối cùng của dòng: Windows sử dụng CRLF (\r\n), các hệ thống giống Unix sử dụng LF (\n).

    Hãy lưu ý điều này khi so sánh các tệp văn bản. Hãy lưu ý đến chế độ cài đặt Git, đặc biệt là phần kết thúc dòng khi thanh toán hoặc cam kết. (Xem cài đặt core.autocrlf của Git.)

Giải pháp:

  • Sử dụng quy tắc không có mục đích riêng.

    native.genrule() là trình bao bọc cho các lệnh Bash và thường được dùng để giải quyết các vấn đề đơn giản như sao chép tệp hoặc ghi tệp văn bản. Bạn có thể tránh dựa vào Bash (và đổi mới sáng tạo): xem liệu bazel-skylib có quy tắc riêng cho nhu cầu của bạn hay không. Không có công cụ nào phụ thuộc vào Bash khi được tạo/kiểm thử trên Windows.

    Ví dụ về quy tắc tạo:

    • copy_file() (nguồn, tài liệu): sao chép tệp ở nơi khác, tuỳ ý tạo tệp thực thi

    • write_file() (nguồn, tài liệu): ghi một tệp văn bản, với các phần cuối dòng mong muốn (auto, unix hoặc windows), tuỳ ý biến tệp đó thành tệp thực thi (nếu là tập lệnh)

    • run_binary() (nguồn, tài liệu): chạy một tệp nhị phân (hoặc quy tắc *_binary) với các dữ liệu đầu vào và đầu ra dự kiến cho sẵn ở dạng hành động tạo bản dựng (đây là trình bao bọc quy tắc bản dựng cho ctx.actions.run)

    • native_binary() (nguồn, tài liệu): bao bọc tệp nhị phân gốc trong quy tắc *_binary mà bạn có thể bazel run hoặc sử dụng trong thuộc tính tool của run_binary() hoặc thuộc tính tools của native.genrule()

    Ví dụ về quy tắc kiểm thử:

    • diff_test() (nguồn, tài liệu): kiểm thử so sánh nội dung của hai tệp

    • native_test() (nguồn, tài liệu): gói tệp nhị phân gốc trong quy tắc *_test mà bạn có thể bazel test

  • Trên Windows, hãy cân nhắc sử dụng tập lệnh .bat cho những vấn đề nhỏ.

    Thay vì tập lệnh .sh, bạn có thể giải quyết các tác vụ đơn giản bằng tập lệnh .bat.

    Ví dụ: nếu cần một tập lệnh không làm gì cả, hoặc in thông báo hay thoát với một mã lỗi cố định, thì bạn chỉ cần một tệp .bat đơn giản. Nếu quy tắc của bạn trả về trình cung cấp DefaultInfo(), thì trường executable có thể tham chiếu đến tệp .bat đó trên Windows.

    Và vì đuôi tệp không quan trọng trên macOS và Linux, bạn luôn có thể dùng .bat làm đuôi tệp, ngay cả đối với các tập lệnh shell.

    Lưu ý rằng không thể thực thi các tệp .bat trống. Nếu bạn cần một tập lệnh trống, hãy viết một khoảng trống vào đó.

  • Sử dụng Bash theo nguyên tắc.

    Trong các quy tắc xây dựng và kiểm thử của Starlark, sử dụng ctx.actions.run_shell để chạy tập lệnh Bash và lệnh Bash dưới dạng hành động.

    Trong macro Starlark, hãy gói các tập lệnh Bash và lệnh trong một native.sh_binary() hoặc native.genrule(). Bazel sẽ kiểm tra xem Bash có sẵn hay không và chạy tập lệnh hoặc lệnh thông qua Bash.

    Trong các quy tắc của kho lưu trữ Starlark, hãy cố gắng tránh Bash hoàn toàn. Bazel hiện không cung cấp cách nào để chạy lệnh Bash theo nguyên tắc trong các quy tắc kho lưu trữ.

Đang xóa tệp

Vấn đề:

  • Bạn không thể xoá tệp khi đang mở.

    Bạn không thể xoá các tệp đang mở (theo mặc định), các lần thử sẽ dẫn đến lỗi "Truy cập bị từ chối". Nếu bạn không thể xoá một tệp, thì có thể một quy trình đang chạy vẫn giữ tệp đang mở.

  • Không thể xoá thư mục làm việc của một quy trình đang chạy.

    Các quy trình có một xử lý mở cho thư mục đang hoạt động của chúng và bạn không thể xoá thư mục đó cho đến khi quá trình kết thúc.

Giải pháp:

  • Trong mã của bạn, hãy cố gắng đóng các tệp ngay lập tức.

    Trong Java, hãy sử dụng try-with-resources. Trong Python, hãy dùng with open(...) as f:. Theo nguyên tắc, hãy thử đóng các tên người dùng càng sớm càng tốt.